Honeybee logo
Documentation Powered by ReDoc

Honeybee Model Schema (1.42.0)

Download OpenAPI specification:Download

Ladybug Tools: info@ladybug.tools URL: https://github.com/ladybug-tools/honeybee-schema License: BSD

Documentation for Honeybee model schema

OpenAPI Specification with Inheritance

_AllAirBase

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

economizer_type
string
Default: "Inferred"
Enum: "Inferred" "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

{
  • "type": "_AllAirBase",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "economizer_type": "Inferred",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    }
}

_DOASBase

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

{
  • "type": "_DOASBase",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    }
}

_EquipmentBase

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by electricequipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "_EquipmentBase",
  • "identifier": "string",
  • "display_name": "string",
  • "watts_per_area": 0,
  • "schedule": "string",
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

_FaceSubSet

type
string^_FaceSubSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

An OpaqueConstruction for walls with a Surface or Adiabatic boundary condition.

exterior_construction
object (Exterior Construction) Recursive

An OpaqueConstruction for walls with an Outdoors boundary condition.

ground_construction
object (Ground Construction) Recursive

An OpaqueConstruction for walls with a Ground boundary condition.

{
  • "type": "_FaceSubSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "ground_construction": {
    }
}

_FaceSubSetAbridged

type
string^_FaceSubSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.

ground_construction
string (Ground Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Ground boundary condition.

{
  • "type": "_FaceSubSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "ground_construction": "string"
}

_HeatCoolBase

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

{
  • "type": "_HeatCoolBase",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013"
}

_OpenAPIGenBaseModel

type
string (Type)
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "InvalidType"
}

_PropertiesBaseAbridged

type
string^_PropertiesBaseAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

{
  • "type": "_PropertiesBaseAbridged",
  • "modifier": "string",
  • "modifier_blk": "string"
}

_RadianceAsset

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

room_identifier
string (Room Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Optional text string for the Room identifier to which this object belongs. This will be used to narrow down the number of aperture groups that have to be run with this sensor grid. If None, the grid will be run with all aperture groups in the model.

light_path
Array of Array of strings (Light Path)

Get or set a list of lists for the light path from the object to the sky. Each sub-list contains identifiers of aperture groups through which light passes. (eg. [["SouthWindow1"], ["static_apertures", "NorthWindow2"]]).Setting this property will override any auto-calculation of the light path from the model and room_identifier upon export to the simulation.

{
  • "type": "_RadianceAsset",
  • "identifier": "string",
  • "display_name": "string",
  • "room_identifier": "string",
  • "light_path": [
    ]
}

_TemplateSystem

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

{
  • "type": "_TemplateSystem",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013"
}

Adiabatic

type
string^Adiabatic$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Adiabatic"
}

AFNCrack

type
string^AFNCrack$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

flow_coefficient
required
number <double> (Flow Coefficient)

A number in kg/s-m at 1 Pa per meter of crack length at the conditions defined in the ReferenceCrack condition; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage wall to be 0.00001 and 0.001 for external and internal constructions, respectively. Flow coefficients for a very poor, high-leakage wall are defined to be 0.0004 and 0.019 for external and internal constructions, respectively.

flow_exponent
number <double> (Flow Exponent) [ 0.5 .. 1 ]
Default: 0.65

An optional dimensionless number between 0.5 and 1 used to calculate the crack mass flow rate; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.

{
  • "type": "AFNCrack",
  • "flow_coefficient": 0,
  • "flow_exponent": 0.65
}

AirBoundaryConstruction

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Air Mixing Schedule)

A fractional schedule as a ScheduleRuleset or ScheduleFixedInterval for the air mixing schedule across the construction.

air_mixing_per_area
number <double> (Air Mixing Per Area) >= 0
Default: 0.1

A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.

{
  • "type": "AirBoundaryConstruction",
  • "identifier": "string",
  • "display_name": "string",
  • "air_mixing_schedule": {
    },
  • "air_mixing_per_area": 0.1
}

AirBoundaryConstructionAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

air_mixing_schedule
required
string (Air Mixing Schedule) [ 1 .. 100 ] characters

Identifier of a fractional schedule for the air mixing schedule across the construction.

air_mixing_per_area
number <double> (Air Mixing Per Area) >= 0
Default: 0.1

A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.

{
  • "type": "AirBoundaryConstructionAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "air_mixing_schedule": "string",
  • "air_mixing_per_area": 0.1
}

AllAirEconomizerType

string (AllAirEconomizerType)
Enum: "Inferred" "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

An enumeration.

"Inferred"

Aperture

type
string^IDdBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

geometry
required
object (Geometry) Recursive

Planar Face3D for the geometry.

required
Outdoors (object) or Surface (object) (Boundary Condition)
properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

is_operable
boolean (Is Operable)
Default: false

Boolean to note whether the Aperture can be opened for ventilation.

Array of objects (Indoor Shades)

Shades assigned to the interior side of this object (eg. window sill, light shelf).

Array of objects (Outdoor Shades)

Shades assigned to the exterior side of this object (eg. mullions, louvers).

{
  • "type": "Aperture",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": {
    },
  • "boundary_condition": {
    },
  • "properties": {
    },
  • "is_operable": false,
  • "indoor_shades": [
    ],
  • "outdoor_shades": [
    ]
}

ApertureConstructionSet

type
string^ApertureConstructionSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

A WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.

window_construction
object (Window Construction) Recursive

A WindowConstruction for all apertures with a Surface boundary condition.

skylight_construction
object (Skylight Construction) Recursive

A WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

operable_construction
object (Operable Construction) Recursive

A WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.

{
  • "type": "ApertureConstructionSet",
  • "interior_construction": {
    },
  • "window_construction": {
    },
  • "skylight_construction": {
    },
  • "operable_construction": {
    }
}

ApertureConstructionSetAbridged

type
string^ApertureConstructionSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.

window_construction
string (Window Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for all apertures with a Surface boundary condition.

skylight_construction
string (Skylight Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

operable_construction
string (Operable Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.

{
  • "type": "ApertureConstructionSetAbridged",
  • "interior_construction": "string",
  • "window_construction": "string",
  • "skylight_construction": "string",
  • "operable_construction": "string"
}

ApertureEnergyPropertiesAbridged

type
string^ApertureEnergyPropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

construction
string (Construction) [ 1 .. 100 ] characters

Identifier of a WindowConstruction for the aperture. If None, the construction is set by the parent Room construction_set or the Model global_construction_set.

vent_opening
object (Vent Opening) Recursive

An optional VentilationOpening to specify the operable portion of the Aperture.

{
  • "type": "ApertureEnergyPropertiesAbridged",
  • "construction": "string",
  • "vent_opening": {
    }
}

ApertureModifierSet

type
string^ApertureModifierSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Window Modifier)

A modifier object for apertures with an Outdoors boundary condition, False is_operable property, and Wall parent Face.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A modifier object for apertures with a Surface boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Skylight Modifier)

A modifier object for apertures with an Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Operable Modifier)

A modifier object for apertures with an Outdoors boundary condition and a True is_operable property.

{
  • "type": "ApertureModifierSet",
  • "window_modifier": {
    },
  • "interior_modifier": {
    },
  • "skylight_modifier": {
    },
  • "operable_modifier": {
    }
}

ApertureModifierSetAbridged

type
string^ApertureModifierSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

window_modifier
string (Window Modifier)

Identifier of modifier object for apertures with an Outdoors boundary condition, False is_operable property, and Wall parent Face.

interior_modifier
string (Interior Modifier)

Identifier of modifier object for apertures with a Surface boundary condition.

skylight_modifier
string (Skylight Modifier)

Identifier of modifier object for apertures with an Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

operable_modifier
string (Operable Modifier)

Identifier of modifier object for apertures with an Outdoors boundary condition and a True is_operable property.

{
  • "type": "ApertureModifierSetAbridged",
  • "window_modifier": "string",
  • "interior_modifier": "string",
  • "skylight_modifier": "string",
  • "operable_modifier": "string"
}

AperturePropertiesAbridged

type
string^AperturePropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

energy
object (ApertureEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (ApertureRadiancePropertiesAbridged) Recursive

Radiance Properties for Honeybee Aperture Abridged.

{
  • "type": "AperturePropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

ApertureRadiancePropertiesAbridged

type
string^_PropertiesBaseAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

dynamic_group_identifier
string (Dynamic Group Identifier)

An optional string to note the dynamic group ' 'to which the Aperture is a part of. Apertures sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Aperture is assumed to be static. (default: None).

Array of objects (States)

An optional list of abridged states (default: None).

{
  • "type": "ApertureRadiancePropertiesAbridged",
  • "modifier": "string",
  • "modifier_blk": "string",
  • "dynamic_group_identifier": "string",
  • "states": [
    ]
}

Autocalculate

type
string^Autocalculate$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Autocalculate"
}

Autosize

type
string^Autosize$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Autosize"
}

Baseboard

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

equipment_type
string
Default: "ElectricBaseboard"
Enum: "ElectricBaseboard" "BoilerBaseboard" "ASHPBaseboard" "DHWBaseboard"

Text for the specific type of system equipment from the BaseboardEquipmentType enumeration.

{
  • "type": "Baseboard",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "equipment_type": "ElectricBaseboard"
}

BaseboardEquipmentType

string (BaseboardEquipmentType)
Enum: "ElectricBaseboard" "BoilerBaseboard" "ASHPBaseboard" "DHWBaseboard"

An enumeration.

"ElectricBaseboard"

BaseModifierSet

type
string^BaseModifierSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "BaseModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

BaseModifierSetAbridged

type
string^BaseModifierSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "BaseModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

BSDF

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

bsdf_data
required
string (Bsdf Data)

A string with the contents of the BSDF XML file.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"void"}

Material modifier (default: Void).

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).

up_orientation
Array of numbers <double> (Up Orientation) 3 items
Default: [0.01,0.01,1]

Vector as sequence that sets the hemisphere that the BSDF material faces. (default: (0.01, 0.01, 1.00).

thickness
number <double> (Thickness)
Default: 0

Optional number to set the thickness of the BSDF material Sign of thickness indicates whether proxied geometry is behind the BSDF surface (when thickness is positive) or in front (when thickness is negative)(default: 0).

function_file
string (Function File) [ 1 .. 100 ] characters
Default: "."

Optional input for function file (default: ".").

transform
string (Transform) [ 1 .. 100 ] characters

Optional transform input to scale the thickness and reorient the up vector (default: None).

front_diffuse_reflectance
Array of numbers <double> (Front Diffuse Reflectance) 3 items

Optional additional front diffuse reflectance as sequence of numbers (default: None).

back_diffuse_reflectance
Array of numbers <double> (Back Diffuse Reflectance) 3 items

Optional additional back diffuse reflectance as sequence of numbers (default: None).

diffuse_transmittance
Array of numbers <double> (Diffuse Transmittance) 3 items

Optional additional diffuse transmittance as sequence of numbers (default: None).

{
  • "type": "BSDF",
  • "identifier": "string",
  • "display_name": "string",
  • "bsdf_data": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "up_orientation": [
    ],
  • "thickness": 0,
  • "function_file": ".",
  • "transform": "string",
  • "front_diffuse_reflectance": [
    ],
  • "back_diffuse_reflectance": [
    ],
  • "diffuse_transmittance": [
    ]
}

BuildingType

string (BuildingType)
Enum: "LowRise" "HighRise"

An enumeration.

"LowRise"

Color

type
string^Color$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

r
required
integer <int32> (R) [ 0 .. 255 ]

Integer for red value.

g
required
integer <int32> (G) [ 0 .. 255 ]

Integer for green value.

b
required
integer <int32> (B) [ 0 .. 255 ]

Integer for blue value.

{
  • "type": "Color",
  • "r": 0,
  • "g": 0,
  • "b": 0
}

ConstructionSet

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

wall_set
object (Wall Set) Recursive

A WallConstructionSet object for this ConstructionSet.

floor_set
object (Floor Set) Recursive

A FloorConstructionSet object for this ConstructionSet.

roof_ceiling_set
object (Roof Ceiling Set) Recursive

A RoofCeilingConstructionSet object for this ConstructionSet.

aperture_set
object (Aperture Set) Recursive

A ApertureConstructionSet object for this ConstructionSet.

door_set
object (Door Set) Recursive

A DoorConstructionSet object for this ConstructionSet.

shade_construction
object (Shade Construction) Recursive

A ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.

air_boundary_construction
object (Air Boundary Construction) Recursive

An AirBoundaryConstruction to set the properties of Faces with an AirBoundary type.

{
  • "type": "ConstructionSet",
  • "identifier": "string",
  • "display_name": "string",
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_construction": {
    },
  • "air_boundary_construction": {
    }
}

ConstructionSetAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

wall_set
object (Wall Set) Recursive

A WallConstructionSetAbridged object for this ConstructionSet.

floor_set
object (Floor Set) Recursive

A FloorConstructionSetAbridged object for this ConstructionSet.

roof_ceiling_set
object (Roof Ceiling Set) Recursive

A RoofCeilingConstructionSetAbridged object for this ConstructionSet.

aperture_set
object (Aperture Set) Recursive

A ApertureConstructionSetAbridged object for this ConstructionSet.

door_set
object (Door Set) Recursive

A DoorConstructionSetAbridged object for this ConstructionSet.

shade_construction
string (Shade Construction) [ 1 .. 100 ] characters

The identifier of a ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.

air_boundary_construction
string (Air Boundary Construction) [ 1 .. 100 ] characters

The identifier of an AirBoundaryConstruction to set the properties of Faces with an AirBoundary type.

{
  • "type": "ConstructionSetAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_construction": "string",
  • "air_boundary_construction": "string"
}

ControlType

string (ControlType)
Enum: "AlwaysOn" "OnIfHighSolarOnWindow" "OnIfHighHorizontalSolar" "OnIfHighOutdoorAirTemperature" "OnIfHighZoneAirTemperature" "OnIfHighZoneCooling" "OnNightIfLowOutdoorTempAndOffDay" "OnNightIfLowInsideTempAndOffDay" "OnNightIfHeatingAndOffDay"

Choices for how the shading device is controlled.

"AlwaysOn"

DatedBaseModel

type
string^DatedBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "DatedBaseModel"
}

Door

type
string^IDdBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

geometry
required
object (Geometry) Recursive

Planar Face3D for the geometry.

required
Outdoors (object) or Surface (object) (Boundary Condition)
properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

is_glass
boolean (Is Glass)
Default: false

Boolean to note whether this object is a glass door as opposed to an opaque door.

Array of objects (Indoor Shades)

Shades assigned to the interior side of this object.

Array of objects (Outdoor Shades)

Shades assigned to the exterior side of this object (eg. entryway awning).

{
  • "type": "Door",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": {
    },
  • "boundary_condition": {
    },
  • "properties": {
    },
  • "is_glass": false,
  • "indoor_shades": [
    ],
  • "outdoor_shades": [
    ]
}

DoorConstructionSet

type
string^DoorConstructionSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

An OpaqueConstruction for all opaque doors with a Surface boundary condition.

exterior_construction
object (Exterior Construction) Recursive

An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.

overhead_construction
object (Overhead Construction) Recursive

An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.

exterior_glass_construction
object (Exterior Glass Construction) Recursive

A WindowConstruction for all glass doors with an Outdoors boundary condition.

interior_glass_construction
object (Interior Glass Construction) Recursive

A WindowConstruction for all glass doors with a Surface boundary condition.

{
  • "type": "DoorConstructionSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "overhead_construction": {
    },
  • "exterior_glass_construction": {
    },
  • "interior_glass_construction": {
    }
}

DoorConstructionSetAbridged

type
string^DoorConstructionSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for all opaque doors with a Surface boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.

overhead_construction
string (Overhead Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.

exterior_glass_construction
string (Exterior Glass Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for all glass doors with an Outdoors boundary condition.

interior_glass_construction
string (Interior Glass Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for all glass doors with a Surface boundary condition.

{
  • "type": "DoorConstructionSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "overhead_construction": "string",
  • "exterior_glass_construction": "string",
  • "interior_glass_construction": "string"
}

DoorEnergyPropertiesAbridged

type
string^DoorEnergyPropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

construction
string (Construction) [ 1 .. 100 ] characters

Identifier of an OpaqueConstruction or WindowConstruction for the door. Note that the host door must have the is_glass property set to True to assign a WindowConstruction. If None, the construction is set by the parent Room construction_set or the Model global_construction_set.

vent_opening
object (Vent Opening) Recursive

An optional VentilationOpening to specify the operable portion of the Door.

{
  • "type": "DoorEnergyPropertiesAbridged",
  • "construction": "string",
  • "vent_opening": {
    }
}

DoorModifierSet

type
string^DoorModifierSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Glass Modifier)

A modifier object for glass with a Surface boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Glass Modifier)

A modifier object for glass with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Overhead Modifier)

A window modifier object for doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.

{
  • "type": "DoorModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    },
  • "interior_glass_modifier": {
    },
  • "exterior_glass_modifier": {
    },
  • "overhead_modifier": {
    }
}

DoorModifierSetAbridged

type
string^BaseModifierSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

interior_glass_modifier
string (Interior Glass Modifier)

Identifier of modifier object for glass with a Surface boundary condition.

exterior_glass_modifier
string (Exterior Glass Modifier)

Identifier of modifier object for glass with an Outdoors boundary condition.

overhead_modifier
string (Overhead Modifier)

Identifier of a modifier object for doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.

{
  • "type": "DoorModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string",
  • "interior_glass_modifier": "string",
  • "exterior_glass_modifier": "string",
  • "overhead_modifier": "string"
}

DoorPropertiesAbridged

type
string^DoorPropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

energy
object (DoorEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (DoorRadiancePropertiesAbridged) Recursive

Radiance Properties for Honeybee Door Abridged.

{
  • "type": "DoorPropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

DoorRadiancePropertiesAbridged

type
string^_PropertiesBaseAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

dynamic_group_identifier
string (Dynamic Group Identifier)

An optional string to note the dynamic group ' 'to which the Door is a part of. Doors sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Door is assumed to be static. (default: None).

Array of objects (States)

An optional list of abridged states (default: None).

{
  • "type": "DoorRadiancePropertiesAbridged",
  • "modifier": "string",
  • "modifier_blk": "string",
  • "dynamic_group_identifier": "string",
  • "states": [
    ]
}

EconomizerType

string (EconomizerType)
Enum: "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

An enumeration.

"NoEconomizer"

ElectricEquipment

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by electricequipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "ElectricEquipment",
  • "identifier": "string",
  • "display_name": "string",
  • "watts_per_area": 0,
  • "schedule": {
    },
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

ElectricEquipmentAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by electricequipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "ElectricEquipmentAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "watts_per_area": 0,
  • "schedule": "string",
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

EnergyMaterial

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

thickness
required
number <double> (Thickness) <= 3

Thickness of the material layer in meters.

conductivity
required
number <double> (Conductivity)

Thermal conductivity of the material layer in W/(m-K).

density
required
number <double> (Density)

Density of the material layer in kg/m3.

specific_heat
required
number <double> (Specific Heat) >= 100

Specific heat of the material layer in J/(kg-K).

roughness
string
Default: "MediumRough"
Enum: "VeryRough" "Rough" "MediumRough" "MediumSmooth" "Smooth" "VerySmooth"

Relative roughness of a particular material layer.

thermal_absorptance
number <double> (Thermal Absorptance) <= 0.99999
Default: 0.9

Fraction of incident long wavelength radiation that is absorbed by the material. Default value is 0.9.

solar_absorptance
number <double> (Solar Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident solar radiation absorbed by the material. Default value is 0.7.

visible_absorptance
number <double> (Visible Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident visible wavelength radiation absorbed by the material. Default value is 0.7.

{
  • "type": "EnergyMaterial",
  • "identifier": "string",
  • "display_name": "string",
  • "thickness": 0,
  • "conductivity": 0,
  • "density": 0,
  • "specific_heat": 100,
  • "roughness": "VeryRough",
  • "thermal_absorptance": 0.9,
  • "solar_absorptance": 0.7,
  • "visible_absorptance": 0.7
}

EnergyMaterialNoMass

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

r_value
required
number <double> (R Value) >= 0.001

The thermal resistance (R-value) of the material layer [m2-K/W].

roughness
string
Default: "MediumRough"
Enum: "VeryRough" "Rough" "MediumRough" "MediumSmooth" "Smooth" "VerySmooth"

Relative roughness of a particular material layer.

thermal_absorptance
number <double> (Thermal Absorptance) <= 0.99999
Default: 0.9

Fraction of incident long wavelength radiation that is absorbed by the material. Default value is 0.9.

solar_absorptance
number <double> (Solar Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident solar radiation absorbed by the material. Default value is 0.7.

visible_absorptance
number <double> (Visible Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident visible wavelength radiation absorbed by the material. Default value is 0.7.

{
  • "type": "EnergyMaterialNoMass",
  • "identifier": "string",
  • "display_name": "string",
  • "r_value": 0.001,
  • "roughness": "VeryRough",
  • "thermal_absorptance": 0.9,
  • "solar_absorptance": 0.7,
  • "visible_absorptance": 0.7
}

EnergyWindowMaterialBlind

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

slat_orientation
string
Default: "Horizontal"
Enum: "Horizontal" "Vertical"

An enumeration.

slat_width
number <double> (Slat Width) <= 1
Default: 0.025

The width of slat measured from edge to edge in meters.

slat_separation
number <double> (Slat Separation) <= 1
Default: 0.01875

The distance between the front of a slat and the back of the adjacent slat in meters.

slat_thickness
number <double> (Slat Thickness) <= 0.1
Default: 0.001

The distance between the faces of a slat in meters. The default value is 0.001.

slat_angle
number <double> (Slat Angle) [ 0 .. 180 ]
Default: 45

The angle (degrees) between the glazing outward normal and the slat outward normal where the outward normal points away from the front face of the slat (degrees). The default value is 45.

slat_conductivity
number <double> (Slat Conductivity)
Default: 221

The thermal conductivity of the slat in W/(m-K). Default value is 221.

beam_solar_transmittance
number <double> (Beam Solar Transmittance) >= 0
Default: 0

The beam solar transmittance of the slat, assumed to be independent of angle of incidence on the slat. Any transmitted beam radiation is assumed to be 100% diffuse (i.e., slats are translucent). The default value is 0.

beam_solar_reflectance
number <double> (Beam Solar Reflectance) >= 0
Default: 0.5

The beam solar reflectance of the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.

beam_solar_reflectance_back
number <double> (Beam Solar Reflectance Back) >= 0
Default: 0.5

The beam solar reflectance of the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.

diffuse_solar_transmittance
number <double> (Diffuse Solar Transmittance) >= 0
Default: 0

The slat transmittance for hemisperically diffuse solar radiation. Default value is 0.

diffuse_solar_reflectance
number <double> (Diffuse Solar Reflectance) >= 0
Default: 0.5

The front-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.

diffuse_solar_reflectance_back
number <double> (Diffuse Solar Reflectance Back) >= 0
Default: 0.5

The back-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.

beam_visible_transmittance
number <double> (Beam Visible Transmittance) >= 0
Default: 0

The beam visible transmittance of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.

beam_visible_reflectance
number <double> (Beam Visible Reflectance) >= 0
Default: 0.5

The beam visible reflectance on the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.

beam_visible_reflectance_back
number <double> (Beam Visible Reflectance Back) >= 0
Default: 0.5

The beam visible reflectance on the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.

diffuse_visible_transmittance
number <double> (Diffuse Visible Transmittance) >= 0
Default: 0

The slat transmittance for hemispherically diffuse visible radiation. This value should equal “Slat Beam Visible Transmittance.”

diffuse_visible_reflectance
number <double> (Diffuse Visible Reflectance) >= 0
Default: 0.5

The front-side slat reflectance for hemispherically diffuse visible radiation. This value should equal “Front Side Slat Beam Visible Reflectance.” Default value is 0.5.

diffuse_visible_reflectance_back
number <double> (Diffuse Visible Reflectance Back) >= 0
Default: 0.5

The back-side slat reflectance for hemispherically diffuse visible radiation. This value should equal “Back Side Slat Beam Visible Reflectance. Default value is 0.5.”

infrared_transmittance
number <double> (Infrared Transmittance) >= 0
Default: 0

The slat infrared hemispherical transmittance. It is zero for solid metallic, wooden or glass slats, but may be non-zero in some cases such as for thin plastic slats. The default value is 0.

emissivity
number <double> (Emissivity) >= 0
Default: 0.9

Front side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.

emissivity_back
number <double> (Emissivity Back) >= 0
Default: 0.9

Back side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.

distance_to_glass
number <double> (Distance To Glass) [ 0.01 .. 1 ]
Default: 0.05

The distance from the mid-plane of the blind to the adjacent glass in meters. The default value is 0.05.

top_opening_multiplier
number <double> (Top Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. The default value is 0.5

bottom_opening_multiplier
number <double> (Bottom Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. The default value is 0.

left_opening_multiplier
number <double> (Left Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.

right_opening_multiplier
number <double> (Right Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.

{
  • "type": "EnergyWindowMaterialBlind",
  • "identifier": "string",
  • "display_name": "string",
  • "slat_orientation": "Horizontal",
  • "slat_width": 0.025,
  • "slat_separation": 0.01875,
  • "slat_thickness": 0.001,
  • "slat_angle": 45,
  • "slat_conductivity": 221,
  • "beam_solar_transmittance": 0,
  • "beam_solar_reflectance": 0.5,
  • "beam_solar_reflectance_back": 0.5,
  • "diffuse_solar_transmittance": 0,
  • "diffuse_solar_reflectance": 0.5,
  • "diffuse_solar_reflectance_back": 0.5,
  • "beam_visible_transmittance": 0,
  • "beam_visible_reflectance": 0.5,
  • "beam_visible_reflectance_back": 0.5,
  • "diffuse_visible_transmittance": 0,
  • "diffuse_visible_reflectance": 0.5,
  • "diffuse_visible_reflectance_back": 0.5,
  • "infrared_transmittance": 0,
  • "emissivity": 0.9,
  • "emissivity_back": 0.9,
  • "distance_to_glass": 0.05,
  • "top_opening_multiplier": 0.5,
  • "bottom_opening_multiplier": 0.5,
  • "left_opening_multiplier": 0.5,
  • "right_opening_multiplier": 0.5
}

EnergyWindowMaterialGas

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

thickness
number <double> (Thickness)
Default: 0.0125

Thickness of the gas layer in meters. Default value is 0.0125.

gas_type
string
Default: "Air"
Enum: "Air" "Argon" "Krypton" "Xenon"

An enumeration.

{
  • "type": "EnergyWindowMaterialGas",
  • "identifier": "string",
  • "display_name": "string",
  • "thickness": 0.0125,
  • "gas_type": "Air"
}

EnergyWindowMaterialGasCustom

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

conductivity_coeff_a
required
number <double> (Conductivity Coeff A)

The A coefficient for gas conductivity in W/(m-K).

viscosity_coeff_a
required
number <double> (Viscosity Coeff A)

The A coefficient for gas viscosity in kg/(m-s).

specific_heat_coeff_a
required
number <double> (Specific Heat Coeff A)

The A coefficient for gas specific heat in J/(kg-K).

specific_heat_ratio
required
number <double> (Specific Heat Ratio)

The specific heat ratio for gas.

molecular_weight
required
number <double> (Molecular Weight) [ 20 .. 200 ]

The molecular weight for gas in g/mol.

thickness
number <double> (Thickness)
Default: 0.0125

Thickness of the gas layer in meters. Default value is 0.0125.

conductivity_coeff_b
number <double> (Conductivity Coeff B)
Default: 0

The B coefficient for gas conductivity in W/(m-K2).

conductivity_coeff_c
number <double> (Conductivity Coeff C)
Default: 0

The C coefficient for gas conductivity in W/(m-K3).

viscosity_coeff_b
number <double> (Viscosity Coeff B)
Default: 0

The B coefficient for gas viscosity in kg/(m-s-K).

viscosity_coeff_c
number <double> (Viscosity Coeff C)
Default: 0

The C coefficient for gas viscosity in kg/(m-s-K2).

specific_heat_coeff_b
number <double> (Specific Heat Coeff B)
Default: 0

The B coefficient for gas specific heat in J/(kg-K2).

specific_heat_coeff_c
number <double> (Specific Heat Coeff C)
Default: 0

The C coefficient for gas specific heat in J/(kg-K3).

{
  • "type": "EnergyWindowMaterialGasCustom",
  • "identifier": "string",
  • "display_name": "string",
  • "conductivity_coeff_a": 0,
  • "viscosity_coeff_a": 0,
  • "specific_heat_coeff_a": 0,
  • "specific_heat_ratio": 0,
  • "molecular_weight": 20,
  • "thickness": 0.0125,
  • "conductivity_coeff_b": 0,
  • "conductivity_coeff_c": 0,
  • "viscosity_coeff_b": 0,
  • "viscosity_coeff_c": 0,
  • "specific_heat_coeff_b": 0,
  • "specific_heat_coeff_c": 0
}

EnergyWindowMaterialGasMixture

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

gas_types
required
Array of strings (GasType) [ 2 .. 4 ] items
Items Enum: "Air" "Argon" "Krypton" "Xenon"

List of gases in the gas mixture.

gas_fractions
required
Array of numbers <double> (Gas Fractions) [ 2 .. 4 ] items

A list of fractional numbers describing the volumetric fractions of gas types in the mixture. This list must align with the gas_types list and must sum to 1.

thickness
number <double> (Thickness)
Default: 0.0125

The thickness of the gas mixture layer in meters.

{
  • "type": "EnergyWindowMaterialGasMixture",
  • "identifier": "string",
  • "display_name": "string",
  • "gas_types": [
    ],
  • "gas_fractions": [
    ],
  • "thickness": 0.0125
}

EnergyWindowMaterialGlazing

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

thickness
number <double> (Thickness)
Default: 0.003

The surface-to-surface of the glass in meters. Default value is 0.003.

solar_transmittance
number <double> (Solar Transmittance) [ 0 .. 1 ]
Default: 0.85

Transmittance of solar radiation through the glass at normal incidence. Default value is 0.85 for clear glass.

solar_reflectance
number <double> (Solar Reflectance) [ 0 .. 1 ]
Default: 0.075

Reflectance of solar radiation off of the front side of the glass at normal incidence, averaged over the solar spectrum. Default value is 0.075 for clear glass.

solar_reflectance_back
number <double> (Solar Reflectance Back)

Reflectance of solar radiation off of the back side of the glass at normal incidence, averaged over the solar spectrum.

visible_transmittance
number <double> (Visible Transmittance) [ 0 .. 1 ]
Default: 0.9

Transmittance of visible light through the glass at normal incidence. Default value is 0.9 for clear glass.

visible_reflectance
number <double> (Visible Reflectance) [ 0 .. 1 ]
Default: 0.075

Reflectance of visible light off of the front side of the glass at normal incidence. Default value is 0.075 for clear glass.

visible_reflectance_back
number <double> (Visible Reflectance Back) [ 0 .. 1 ]

Reflectance of visible light off of the back side of the glass at normal incidence averaged over the solar spectrum and weighted by the response of the human eye.

infrared_transmittance
number <double> (Infrared Transmittance) [ 0 .. 1 ]
Default: 0

Long-wave transmittance at normal incidence.

emissivity
number <double> (Emissivity) [ 0 .. 1 ]
Default: 0.84

Infrared hemispherical emissivity of the front (outward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.

emissivity_back
number <double> (Emissivity Back) [ 0 .. 1 ]
Default: 0.84

Infrared hemispherical emissivity of the back (inward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.

conductivity
number <double> (Conductivity)
Default: 0.9

Thermal conductivity of the glass in W/(m-K). Default value is 0.9, which is typical for clear glass without a low-e coating.

dirt_correction
number <double> (Dirt Correction)
Default: 1

Factor that corrects for the presence of dirt on the glass. A default value of 1 indicates the glass is clean.

solar_diffusing
boolean (Solar Diffusing)
Default: false

Takes values True and False. If False (default), the beam solar radiation incident on the glass is transmitted as beam radiation with no diffuse component.If True, the beam solar radiation incident on the glass is transmitted as hemispherical diffuse radiation with no beam component.

{
  • "type": "EnergyWindowMaterialGlazing",
  • "identifier": "string",
  • "display_name": "string",
  • "thickness": 0.003,
  • "solar_transmittance": 0.85,
  • "solar_reflectance": 0.075,
  • "solar_reflectance_back": 0,
  • "visible_transmittance": 0.9,
  • "visible_reflectance": 0.075,
  • "visible_reflectance_back": 0,
  • "infrared_transmittance": 0,
  • "emissivity": 0.84,
  • "emissivity_back": 0.84,
  • "conductivity": 0.9,
  • "dirt_correction": 1,
  • "solar_diffusing": false
}

EnergyWindowMaterialShade

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

solar_transmittance
number <double> (Solar Transmittance) >= 0
Default: 0.4

The transmittance averaged over the solar spectrum. It is assumed independent of incidence angle. Default value is 0.4.

solar_reflectance
number <double> (Solar Reflectance) >= 0
Default: 0.5

The reflectance averaged over the solar spectrum. It us assumed same on both sides of shade and independent of incidence angle. Default value is 0.5

visible_transmittance
number <double> (Visible Transmittance) >= 0
Default: 0.4

The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4.

visible_reflectance
number <double> (Visible Reflectance) >= 0
Default: 0.4

The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4

emissivity
number <double> (Emissivity)
Default: 0.9

The effective long-wave infrared hemispherical emissivity. It is assumed same on both sides of shade. Default value is 0.9.

infrared_transmittance
number <double> (Infrared Transmittance) >= 0
Default: 0

The effective long-wave transmittance. It is assumed independent of incidence angle. Default value is 0.

thickness
number <double> (Thickness)
Default: 0.005

The thickness of the shade material in meters. Default value is 0.005.

conductivity
number <double> (Conductivity)
Default: 0.1

The conductivity of the shade material in W/(m-K). Default value is 0.1.

distance_to_glass
number <double> (Distance To Glass) [ 0.001 .. 1 ]
Default: 0.05

The distance from shade to adjacent glass in meters. Default value is 0.05

top_opening_multiplier
number <double> (Top Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.

bottom_opening_multiplier
number <double> (Bottom Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.

left_opening_multiplier
number <double> (Left Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.

right_opening_multiplier
number <double> (Right Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.

airflow_permeability
number <double> (Airflow Permeability) [ 0 .. 0.8 ]
Default: 0

The fraction of the shade surface that is open to air flow. If air cannot pass through the shade material, airflow_permeability = 0. Default value is 0.

{
  • "type": "EnergyWindowMaterialShade",
  • "identifier": "string",
  • "display_name": "string",
  • "solar_transmittance": 0.4,
  • "solar_reflectance": 0.5,
  • "visible_transmittance": 0.4,
  • "visible_reflectance": 0.4,
  • "emissivity": 0.9,
  • "infrared_transmittance": 0,
  • "thickness": 0.005,
  • "conductivity": 0.1,
  • "distance_to_glass": 0.05,
  • "top_opening_multiplier": 0.5,
  • "bottom_opening_multiplier": 0.5,
  • "left_opening_multiplier": 0.5,
  • "right_opening_multiplier": 0.5,
  • "airflow_permeability": 0
}

EnergyWindowMaterialSimpleGlazSys

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

u_factor
required
number <double> (U Factor) <= 5.8

Used to describe the value for window system U-Factor, or overall heat transfer coefficient in W/(m2-K).

shgc
required
number <double> (Shgc)

Unitless quantity describing Solar Heat Gain Coefficient for normal incidence and vertical orientation.

vt
number <double> (Vt)
Default: 0.54

The fraction of visible light falling on the window that makes it through the glass at normal incidence.

{
  • "type": "EnergyWindowMaterialSimpleGlazSys",
  • "identifier": "string",
  • "display_name": "string",
  • "u_factor": 0,
  • "shgc": 0,
  • "vt": 0.54
}

EvaporativeCooler

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

equipment_type
string
Default: "EvapCoolers_ElectricBaseboard"
Enum: "EvapCoolers_ElectricBaseboard" "EvapCoolers_BoilerBaseboard" "EvapCoolers_ASHPBaseboard" "EvapCoolers_DHWBaseboard" "EvapCoolers_Furnace" "EvapCoolers_UnitHeaters" "EvapCoolers"

Text for the specific type of system equipment from the EvaporativeCoolerEquipmentType enumeration.

{
  • "type": "EvaporativeCooler",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "equipment_type": "EvapCoolers_ElectricBaseboard"
}

EvaporativeCoolerEquipmentType

string (EvaporativeCoolerEquipmentType)
Enum: "EvapCoolers_ElectricBaseboard" "EvapCoolers_BoilerBaseboard" "EvapCoolers_ASHPBaseboard" "EvapCoolers_DHWBaseboard" "EvapCoolers_Furnace" "EvapCoolers_UnitHeaters" "EvapCoolers"

An enumeration.

"EvapCoolers_ElectricBaseboard"

Face3D

type
string^Face3D$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

boundary
required
Array of Array of numbers (Boundary) >= 3 items

A list of points representing the outer boundary vertices of the face. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.

holes
Array of Array of Array of numbers (Holes)

Optional list of lists with one list for each hole in the face.Each hole should be a list of at least 3 points and each point a list of 3 (x, y, z) values. If None, it will be assumed that there are no holes in the face.

plane
object (Plane) Recursive

Optional Plane indicating the plane in which the face exists.If None, the plane will usually be derived from the boundary points.

{
  • "type": "Face3D",
  • "boundary": [
    ],
  • "holes": [
    ],
  • "plane": {
    }
}

Face

type
string^IDdBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

geometry
required
object (Geometry) Recursive

Planar Face3D for the geometry.

face_type
required
string (FaceType)
Enum: "Wall" "Floor" "RoofCeiling" "AirBoundary"

An enumeration.

required
Ground (object) or Outdoors (object) or Adiabatic (object) or Surface (object) (Boundary Condition)
properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

Array of objects (Apertures)

Apertures assigned to this Face. Should be coplanar with this Face and completely within the boundary of the Face to be valid.

Array of objects (Doors)

Doors assigned to this Face. Should be coplanar with this Face and completely within the boundary of the Face to be valid.

Array of objects (Indoor Shades)

Shades assigned to the interior side of this object.

Array of objects (Outdoor Shades)

Shades assigned to the exterior side of this object (eg. balcony, overhang).

{
  • "type": "Face",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": {
    },
  • "face_type": "Wall",
  • "boundary_condition": {
    },
  • "properties": {
    },
  • "apertures": [
    ],
  • "doors": [
    ],
  • "indoor_shades": [
    ],
  • "outdoor_shades": [
    ]
}

FaceEnergyPropertiesAbridged

type
string^FaceEnergyPropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

construction
string (Construction) [ 1 .. 100 ] characters

Identifier of an OpaqueConstruction for the Face. If None, the construction is set by the parent Room construction_set or the Model global_construction_set.

vent_crack
object (Vent Crack) Recursive

An optional AFNCrack to specify airflow through a surface crack used by the AirflowNetwork.

{
  • "type": "FaceEnergyPropertiesAbridged",
  • "construction": "string",
  • "vent_crack": {
    }
}

FacePropertiesAbridged

type
string^FacePropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

energy
object (FaceEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (FaceRadiancePropertiesAbridged) Recursive

Radiance Properties for Honeybee Face Abridged.

{
  • "type": "FacePropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

FaceRadiancePropertiesAbridged

type
string^_PropertiesBaseAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

{
  • "type": "FaceRadiancePropertiesAbridged",
  • "modifier": "string",
  • "modifier_blk": "string"
}

FaceType

string (FaceType)
Enum: "Wall" "Floor" "RoofCeiling" "AirBoundary"

An enumeration.

"Wall"

FCU

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

equipment_type
string
Default: "FCU_Chiller_Boiler"
Enum: "FCU_Chiller_Boiler" "FCU_Chiller_ASHP" "FCU_Chiller_DHW" "FCU_Chiller_ElectricBaseboard" "FCU_Chiller_GasHeaters" "FCU_Chiller" "FCU_ACChiller_Boiler" "FCU_ACChiller_ASHP" "FCU_ACChiller_DHW" "FCU_ACChiller_ElectricBaseboard" "FCU_ACChiller_GasHeaters" "FCU_ACChiller" "FCU_DCW_Boiler" "FCU_DCW_ASHP" "FCU_DCW_DHW" "FCU_DCW_ElectricBaseboard" "FCU_DCW_GasHeaters" "FCU_DCW"

Text for the specific type of system equipment from the FCUEquipmentType enumeration.

{
  • "type": "FCU",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "equipment_type": "FCU_Chiller_Boiler"
}

FCUEquipmentType

string (FCUEquipmentType)
Enum: "FCU_Chiller_Boiler" "FCU_Chiller_ASHP" "FCU_Chiller_DHW" "FCU_Chiller_ElectricBaseboard" "FCU_Chiller_GasHeaters" "FCU_Chiller" "FCU_ACChiller_Boiler" "FCU_ACChiller_ASHP" "FCU_ACChiller_DHW" "FCU_ACChiller_ElectricBaseboard" "FCU_ACChiller_GasHeaters" "FCU_ACChiller" "FCU_DCW_Boiler" "FCU_DCW_ASHP" "FCU_DCW_DHW" "FCU_DCW_ElectricBaseboard" "FCU_DCW_GasHeaters" "FCU_DCW"

An enumeration.

"FCU_Chiller_Boiler"

FCUwithDOAS

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

equipment_type
string
Default: "DOAS_FCU_Chiller_Boiler"
Enum: "DOAS_FCU_Chiller_Boiler" "DOAS_FCU_Chiller_ASHP" "DOAS_FCU_Chiller_DHW" "DOAS_FCU_Chiller_ElectricBaseboard" "DOAS_FCU_Chiller_GasHeaters" "DOAS_FCU_Chiller" "DOAS_FCU_ACChiller_Boiler" "DOAS_FCU_ACChiller_ASHP" "DOAS_FCU_ACChiller_DHW" "DOAS_FCU_ACChiller_ElectricBaseboard" "DOAS_FCU_ACChiller_GasHeaters" "DOAS_FCU_ACChiller" "DOAS_FCU_DCW_Boiler" "DOAS_FCU_DCW_ASHP" "DOAS_FCU_DCW_DHW" "DOAS_FCU_DCW_ElectricBaseboard" "DOAS_FCU_DCW_GasHeaters" "DOAS_FCU_DCW"

Text for the specific type of system equipment from the FCUwithDOASEquipmentType enumeration.

{
  • "type": "FCUwithDOAS",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    },
  • "equipment_type": "DOAS_FCU_Chiller_Boiler"
}

FCUwithDOASEquipmentType

string (FCUwithDOASEquipmentType)
Enum: "DOAS_FCU_Chiller_Boiler" "DOAS_FCU_Chiller_ASHP" "DOAS_FCU_Chiller_DHW" "DOAS_FCU_Chiller_ElectricBaseboard" "DOAS_FCU_Chiller_GasHeaters" "DOAS_FCU_Chiller" "DOAS_FCU_ACChiller_Boiler" "DOAS_FCU_ACChiller_ASHP" "DOAS_FCU_ACChiller_DHW" "DOAS_FCU_ACChiller_ElectricBaseboard" "DOAS_FCU_ACChiller_GasHeaters" "DOAS_FCU_ACChiller" "DOAS_FCU_DCW_Boiler" "DOAS_FCU_DCW_ASHP" "DOAS_FCU_DCW_DHW" "DOAS_FCU_DCW_ElectricBaseboard" "DOAS_FCU_DCW_GasHeaters" "DOAS_FCU_DCW"

An enumeration.

"DOAS_FCU_Chiller_Boiler"

FloorConstructionSet

type
string^FloorConstructionSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

An OpaqueConstruction for walls with a Surface or Adiabatic boundary condition.

exterior_construction
object (Exterior Construction) Recursive

An OpaqueConstruction for walls with an Outdoors boundary condition.

ground_construction
object (Ground Construction) Recursive

An OpaqueConstruction for walls with a Ground boundary condition.

{
  • "type": "FloorConstructionSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "ground_construction": {
    }
}

FloorConstructionSetAbridged

type
string^_FaceSubSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.

ground_construction
string (Ground Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Ground boundary condition.

{
  • "type": "FloorConstructionSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "ground_construction": "string"
}

FloorModifierSet

type
string^FloorModifierSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "FloorModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

FloorModifierSetAbridged

type
string^BaseModifierSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "FloorModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

ForcedAirFurnace

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

economizer_type
string
Default: "Inferred"
Enum: "Inferred" "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

equipment_type
string
Default: "Furnace"
Value: "Furnace"

Text for the specific type of system equipment from the FurnaceEquipmentType enumeration.

{
  • "type": "ForcedAirFurnace",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "economizer_type": "Inferred",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    },
  • "equipment_type": "Furnace"
}

FurnaceEquipmentType

string (FurnaceEquipmentType)
Value: "Furnace"

An enumeration.

"Furnace"

GasEquipment

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by electricequipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "GasEquipment",
  • "identifier": "string",
  • "display_name": "string",
  • "watts_per_area": 0,
  • "schedule": {
    },
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

GasEquipmentAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by electricequipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "GasEquipmentAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "watts_per_area": 0,
  • "schedule": "string",
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

GasType

string (GasType)
Enum: "Air" "Argon" "Krypton" "Xenon"

An enumeration.

"Air"

GasUnitHeater

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

equipment_type
string
Default: "GasHeaters"
Value: "GasHeaters"

Text for the specific type of system equipment from the GasUnitHeaterEquipmentType enumeration.

{
  • "type": "GasUnitHeater",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "equipment_type": "GasHeaters"
}

GasUnitHeaterEquipmentType

string (GasUnitHeaterEquipmentType)
Value: "GasHeaters"

An enumeration.

"GasHeaters"

Glass

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"void"}

Material modifier (default: Void).

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).

r_transmissivity
number <double> (R Transmissivity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel transmissivity (default: 0).

g_transmissivity
number <double> (G Transmissivity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel transmissivity (default: 0).

b_transmissivity
number <double> (B Transmissivity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel transmissivity (default: 0).

refraction_index
number <double> (Refraction Index) >= 0
Default: 1.52

A value between 0 and 1 for the index of refraction (default: 1.52).

{
  • "type": "glass",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_transmissivity": 0,
  • "g_transmissivity": 0,
  • "b_transmissivity": 0,
  • "refraction_index": 1.52
}

Glow

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"void"}

Material modifier (default: Void).

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).

r_emittance
number <double> (R Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel of the modifier (default: 0).

g_emittance
number <double> (G Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel of the modifier (default: 0).

b_emittance
number <double> (B Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel of the modifier (default: 0).

max_radius
number <double> (Max Radius)
Default: 0

Maximum radius for shadow testing (default: 0). Surfaces with zero will never be tested for zero, although it may participate in interreflection calculation. Negative values will never contribute to scene illumination.

{
  • "type": "glow",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_emittance": 0,
  • "g_emittance": 0,
  • "b_emittance": 0,
  • "max_radius": 0
}

Ground

type
string^Ground$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Ground"
}

IDdBaseModel

type
string^IDdBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

{
  • "type": "IDdBaseModel",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { }
}

IDdEnergyBaseModel

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

{
  • "type": "IDdEnergyBaseModel",
  • "identifier": "string",
  • "display_name": "string"
}

IDdRadianceBaseModel

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

{
  • "type": "IDdRadianceBaseModel",
  • "identifier": "string",
  • "display_name": "string"
}

IdealAirSystemAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

economizer_type
string
Default: "DifferentialDryBulb"
Enum: "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the zone.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

heating_air_temperature
number <double> (Heating Air Temperature)
Default: 50

A number for the maximum heating supply air temperature [C].

cooling_air_temperature
number <double> (Cooling Air Temperature)
Default: 13

A number for the minimum cooling supply air temperature [C].

Autosize (object) or NoLimit (object) or number (Heating Limit)
Default: {"type":"Autosize"}

A number for the maximum heating capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the heating capacity.

Autosize (object) or NoLimit (object) or number (Cooling Limit)
Default: {"type":"Autosize"}

A number for the maximum cooling capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the cooling capacity.

heating_availability
string (Heating Availability) [ 1 .. 100 ] characters

An optional identifier of a schedule to set the availability of heating over the course of the simulation.

cooling_availability
string (Cooling Availability) [ 1 .. 100 ] characters

An optional identifier of a schedule to set the availability of cooling over the course of the simulation.

{
  • "type": "IdealAirSystemAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "economizer_type": "NoEconomizer",
  • "demand_controlled_ventilation": false,
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "heating_air_temperature": 50,
  • "cooling_air_temperature": 13,
  • "heating_limit": {
    },
  • "cooling_limit": {
    },
  • "heating_availability": "string",
  • "cooling_availability": "string"
}

Infiltration

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

flow_per_exterior_area
required
number <double> (Flow Per Exterior Area) >= 0

Number for the infiltration per exterior surface area in m3/s-m2.

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the infiltration over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_exterior_area to yield a complete infiltration profile.

constant_coefficient
number <double> (Constant Coefficient) >= 0
Default: 1
temperature_coefficient
number <double> (Temperature Coefficient) >= 0
Default: 0
velocity_coefficient
number <double> (Velocity Coefficient) >= 0
Default: 0
{
  • "type": "Infiltration",
  • "identifier": "string",
  • "display_name": "string",
  • "flow_per_exterior_area": 0,
  • "schedule": {
    },
  • "constant_coefficient": 1,
  • "temperature_coefficient": 0,
  • "velocity_coefficient": 0
}

InfiltrationAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

flow_per_exterior_area
required
number <double> (Flow Per Exterior Area) >= 0

Number for the infiltration per exterior surface area in m3/s-m2.

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the infiltration over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_exterior_area to yield a complete infiltration profile.

constant_coefficient
number <double> (Constant Coefficient) >= 0
Default: 1
temperature_coefficient
number <double> (Temperature Coefficient) >= 0
Default: 0
velocity_coefficient
number <double> (Velocity Coefficient) >= 0
Default: 0
{
  • "type": "InfiltrationAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "flow_per_exterior_area": 0,
  • "schedule": "string",
  • "constant_coefficient": 1,
  • "temperature_coefficient": 0,
  • "velocity_coefficient": 0
}

Light

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"void"}

Material modifier (default: Void).

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).

r_emittance
number <double> (R Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel of the modifier (default: 0).

g_emittance
number <double> (G Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel of the modifier (default: 0).

b_emittance
number <double> (B Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel of the modifier (default: 0).

{
  • "type": "light",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_emittance": 0,
  • "g_emittance": 0,
  • "b_emittance": 0
}

Lighting

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

watts_per_area
required
number <double> (Watts Per Area) >= 0

Lighting per floor area as [W/m2].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the use of lights over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete lighting profile.

visible_fraction
number <double> (Visible Fraction) [ 0 .. 1 ]
Default: 0.25

The fraction of heat from lights that goes into the zone as visible (short-wave) radiation. The default value is 0.25.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0.32

The fraction of heat from lights that is long-wave radiation. Default value is 0.32.

return_air_fraction
number <double> (Return Air Fraction) [ 0 .. 1 ]
Default: 0

The fraction of the heat from lights that goes into the zone return air. Default value is 0.

baseline_watts_per_area
number <double> (Baseline Watts Per Area) >= 0
Default: 11.84029

The baseline lighting power density in [W/m2] of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1. If set to None, it will default to 11.84029 W/m2, which is that ASHRAE 90.1-2004 baseline for an office.

{
  • "type": "Lighting",
  • "identifier": "string",
  • "display_name": "string",
  • "watts_per_area": 0,
  • "schedule": {
    },
  • "visible_fraction": 0.25,
  • "radiant_fraction": 0.32,
  • "return_air_fraction": 0,
  • "baseline_watts_per_area": 11.84029
}

LightingAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

watts_per_area
required
number <double> (Watts Per Area) >= 0

Lighting per floor area as [W/m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the use of lights over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete lighting profile.

visible_fraction
number <double> (Visible Fraction) [ 0 .. 1 ]
Default: 0.25

The fraction of heat from lights that goes into the zone as visible (short-wave) radiation. The default value is 0.25.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0.32

The fraction of heat from lights that is long-wave radiation. Default value is 0.32.

return_air_fraction
number <double> (Return Air Fraction) [ 0 .. 1 ]
Default: 0

The fraction of the heat from lights that goes into the zone return air. Default value is 0.

baseline_watts_per_area
number <double> (Baseline Watts Per Area) >= 0
Default: 11.84029

The baseline lighting power density in [W/m2] of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1. If set to None, it will default to 11.84029 W/m2, which is that ASHRAE 90.1-2004 baseline for an office.

{
  • "type": "LightingAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "watts_per_area": 0,
  • "schedule": "string",
  • "visible_fraction": 0.25,
  • "radiant_fraction": 0.32,
  • "return_air_fraction": 0,
  • "baseline_watts_per_area": 11.84029
}

Mesh3D

type
string^Mesh3D$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

vertices
required
Array of Array of numbers (Vertices) >= 3 items

A list of points representing the vertices of the mesh. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.

faces
required
Array of Array of integers (Faces) non-empty

A list of lists with each sub-list having either 3 or 4 integers. These integers correspond to indices within the list of vertices.

Array of objects (Colors)

An optional list of colors that correspond to either the faces of the mesh or the vertices of the mesh.

{
  • "type": "Mesh3D",
  • "vertices": [
    ],
  • "faces": [
    ],
  • "colors": [
    ]
}

Metal

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"void"}

Material modifier (default: Void).

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).

r_reflectance
number <double> (R Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel reflectance (default: 0).

g_reflectance
number <double> (G Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel reflectance (default: 0).

b_reflectance
number <double> (B Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel reflectance (default: 0).

specularity
number <double> (Specularity) [ 0 .. 1 ]
Default: 0.9

A value between 0 and 1 for the fraction of specularity. Specularity fractions lower than 0.9 are not realistic for metallic materials. (default: 0.9).

roughness
number <double> (Roughness) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the roughness, specified as the rms slope of surface facets. Roughness greater than 0.2 are not realistic (default: 0).

{
  • "type": "metal",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_reflectance": 0,
  • "g_reflectance": 0,
  • "b_reflectance": 0,
  • "specularity": 0.9,
  • "roughness": 0
}

Mirror

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"void"}

Material modifier (default: Void).

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).

r_reflectance
number <double> (R Reflectance) [ 0 .. 1 ]
Default: 1

A value between 0 and 1 for the red channel reflectance (default: 1).

g_reflectance
number <double> (G Reflectance) [ 0 .. 1 ]
Default: 1

A value between 0 and 1 for the green channel reflectance (default: 1).

b_reflectance
number <double> (B Reflectance) [ 0 .. 1 ]
Default: 1

A value between 0 and 1 for the blue channel reflectance (default: 1).

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Alternate Material)

An optional material that may be used like the illum type to specify a different material to be used for shading non-source rays. If None, this will keep the alternat_material as mirror. If this alternate material is given as Void, then the mirror surface will be invisible. Using Void is only appropriate if the surface hides other (more detailed) geometry with the same overall reflectance (default: None).

{
  • "type": "mirror",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_reflectance": 1,
  • "g_reflectance": 1,
  • "b_reflectance": 1,
  • "alternate_material": {
    }
}

Model

type
string^IDdBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

version
string (Version) ([0-9]+)\.([0-9]+)\.([0-9]+)
Default: "0.0.0"

Text string for the current version of the schema.

Array of objects (Rooms)

A list of Rooms in the model.

Array of objects (Orphaned Faces)

A list of Faces in the model that lack a parent Room. Note that orphaned Faces are not acceptable for Models that are to be exported for energy simulation.

Array of objects (Orphaned Shades)

A list of Shades in the model that lack a parent.

Array of objects (Orphaned Apertures)

A list of Apertures in the model that lack a parent Face. Note that orphaned Apertures are not acceptable for Models that are to be exported for energy simulation.

Array of objects (Orphaned Doors)

A list of Doors in the model that lack a parent Face. Note that orphaned Doors are not acceptable for Models that are to be exported for energy simulation.

units
string
Default: "Meters"
Enum: "Meters" "Millimeters" "Feet" "Inches" "Centimeters"

Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters.

tolerance
number <double> (Tolerance) >= 0
Default: 0.01

The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and it is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a Model. The default of 0.01 is suitable for models in meters.

angle_tolerance
number <double> (Angle Tolerance) >= 0
Default: 1

The max angle difference in degrees that vertices are allowed to differ from one another in order to consider them colinear. This value is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a given Model.

{
  • "type": "Model",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "properties": {
    },
  • "version": "0.0.0",
  • "rooms": [
    ],
  • "orphaned_faces": [
    ],
  • "orphaned_shades": [
    ],
  • "orphaned_apertures": [
    ],
  • "orphaned_doors": [
    ],
  • "units": "Meters",
  • "tolerance": 0.01,
  • "angle_tolerance": 1
}

ModelEnergyProperties

type
string^ModelEnergyProperties$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

Array of ConstructionSetAbridged (object) or ConstructionSet (object) (Construction Sets)

List of all unique ConstructionSets in the Model.

Array of OpaqueConstructionAbridged (object) or WindowConstructionAbridged (object) or WindowConstructionShadeAbridged (object) or AirBoundaryConstructionAbridged (object) or OpaqueConstruction (object) or WindowConstruction (object) or WindowConstructionShade (object) or AirBoundaryConstruction (object) or ShadeConstruction (object) (Constructions)

A list of all unique constructions in the model. This includes constructions across all Faces, Apertures, Doors, Shades, Room ConstructionSets, and the global_construction_set.

Array of EnergyMaterial (object) or EnergyMaterialNoMass (object) or EnergyWindowMaterialGas (object) or EnergyWindowMaterialGasCustom (object) or EnergyWindowMaterialGasMixture (object) or EnergyWindowMaterialSimpleGlazSys (object) or EnergyWindowMaterialBlind (object) or EnergyWindowMaterialGlazing (object) or EnergyWindowMaterialShade (object) (Materials)

A list of all unique materials in the model. This includes materials needed to make the Model constructions.

Array of IdealAirSystemAbridged (object) or VAV (object) or PVAV (object) or PSZ (object) or PTAC (object) or ForcedAirFurnace (object) or FCUwithDOAS (object) or WSHPwithDOAS (object) or VRFwithDOAS (object) or FCU (object) or WSHP (object) or VRF (object) or Baseboard (object) or EvaporativeCooler (object) or Residential (object) or WindowAC (object) or GasUnitHeater (object) (Hvacs)

List of all unique HVAC systems in the Model.

Array of ProgramTypeAbridged (object) or ProgramType (object) (Program Types)

List of all unique ProgramTypes in the Model.

Array of ScheduleRulesetAbridged (object) or ScheduleFixedIntervalAbridged (object) or ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedules)

A list of all unique schedules in the model. This includes schedules across all HVAC systems, ProgramTypes, Rooms, and Shades.

Array of objects (Schedule Type Limits)

A list of all unique ScheduleTypeLimits in the model. This all ScheduleTypeLimits needed to make the Model schedules.

ventilation_simulation_control
object (Ventilation Simulation Control) Recursive

An optional parameter to define the global parameters for a ventilation cooling.

{
  • "type": "ModelEnergyProperties",
  • "construction_sets": [
    ],
  • "constructions": [
    ],
  • "materials": [
    ],
  • "hvacs": [
    ],
  • "program_types": [
    ],
  • "schedules": [
    ],
  • "schedule_type_limits": [
    ],
  • "ventilation_simulation_control": {
    }
}

ModelProperties

type
string^ModelProperties$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

energy
object (ModelEnergyProperties) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (ModelRadianceProperties) Recursive

Radiance Properties for Honeybee Model.

{
  • "type": "ModelProperties",
  • "energy": {
    },
  • "radiance": {
    }
}

ModelRadianceProperties

type
string^ModelRadianceProperties$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifiers)

A list of all unique modifiers in the model. This includes modifiers across all Faces, Apertures, Doors, Shades, Room ModifierSets, and the global_modifier_set.

Array of ModifierSet (object) or ModifierSetAbridged (object) (Modifier Sets)

A list of all unique Room-Assigned ModifierSets in the Model.

Array of objects (Sensor Grids)

An array of SensorGrids that are associated with the model.

Array of objects (Views)

An array of Views that are associated with the model.

{
  • "type": "ModelRadianceProperties",
  • "modifiers": [
    ],
  • "modifier_sets": [
    ],
  • "sensor_grids": [
    ],
  • "views": [
    ]
}

ModifierBase

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

{
  • "type": "ModifierBase",
  • "identifier": "string",
  • "display_name": "string"
}

ModifierSet

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

wall_set
object (Wall Set) Recursive

An optional WallModifierSet object for this ModifierSet. (default: None).

floor_set
object (Floor Set) Recursive

An optional FloorModifierSet object for this ModifierSet. (default: None).

roof_ceiling_set
object (Roof Ceiling Set) Recursive

An optional RoofCeilingModifierSet object for this ModifierSet. (default: None).

aperture_set
object (Aperture Set) Recursive

An optional ApertureModifierSet object for this ModifierSet. (default: None).

door_set
object (Door Set) Recursive

An optional DoorModifierSet object for this ModifierSet. (default: None).

shade_set
object (Shade Set) Recursive

An optional ShadeModifierSet object for this ModifierSet. (default: None).

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Air Boundary Modifier)

An optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.

{
  • "type": "ModifierSet",
  • "identifier": "string",
  • "display_name": "string",
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_set": {
    },
  • "air_boundary_modifier": {
    }
}

ModifierSetAbridged

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

wall_set
object (Wall Set) Recursive

Optional WallModifierSet object for this ModifierSet (default: None).

floor_set
object (Floor Set) Recursive

Optional FloorModifierSet object for this ModifierSet (default: None).

roof_ceiling_set
object (Roof Ceiling Set) Recursive

Optional RoofCeilingModifierSet object for this ModifierSet (default: None).

aperture_set
object (Aperture Set) Recursive

Optional ApertureModifierSet object for this ModifierSet (default: None).

door_set
object (Door Set) Recursive

Optional DoorModifierSet object for this ModifierSet (default: None).

shade_set
object (Shade Set) Recursive

Optional ShadeModifierSet object for this ModifierSet (default: None).

air_boundary_modifier
string (Air Boundary Modifier)

Optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.

{
  • "type": "ModifierSetAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_set": {
    },
  • "air_boundary_modifier": "string"
}

NoLimit

type
string^NoLimit$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "NoLimit"
}

OpaqueConstruction

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

layers
required
Array of strings (Layers) [ 1 .. 10 ] items

List of strings for opaque material identifiers. The order of the materials is from exterior to interior.

required
Array of EnergyMaterial (object) or EnergyMaterialNoMass (object) (Materials) [ 1 .. 10 ] items

List of opaque materials. The order of the materials is from outside to inside.

{
  • "type": "OpaqueConstruction",
  • "identifier": "string",
  • "display_name": "string",
  • "layers": [
    ],
  • "materials": [
    ]
}

OpaqueConstructionAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

layers
required
Array of strings (Layers) [ 1 .. 10 ] items

List of strings for opaque material identifiers. The order of the materials is from exterior to interior.

{
  • "type": "OpaqueConstructionAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "layers": [
    ]
}

Outdoors

type
string^Outdoors$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

sun_exposure
boolean (Sun Exposure)
Default: true

A boolean noting whether the boundary is exposed to sun.

wind_exposure
boolean (Wind Exposure)
Default: true

A boolean noting whether the boundary is exposed to wind.

Autocalculate (object) or number (View Factor)
Default: {"type":"Autocalculate"}

A number for the view factor to the ground. This can also be an Autocalculate object to have the view factor automatically calculated.

{
  • "type": "Outdoors",
  • "sun_exposure": true,
  • "wind_exposure": true,
  • "view_factor": {
    }
}

People

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

people_per_area
required
number <double> (People Per Area) >= 0

People per floor area expressed as [people/m2]

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Occupancy Schedule)

A schedule for the occupancy over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the people_per_area to yield a complete occupancy profile.

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Activity Schedule)

A schedule for the activity of the occupants over the course of the year. The type of this schedule should be Power and the values of the schedule equal to the number of Watts given off by an individual person in the room.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0.3

The radiant fraction of sensible heat released by people. The defaultvalue is 0.30.

Autocalculate (object) or number (Latent Fraction)
Default: {"type":"Autocalculate"}

Number for the latent fraction of heat gain due to people or an Autocalculate object.

{
  • "type": "People",
  • "identifier": "string",
  • "display_name": "string",
  • "people_per_area": 0,
  • "occupancy_schedule": {
    },
  • "activity_schedule": {
    },
  • "radiant_fraction": 0.3,
  • "latent_fraction": {
    }
}

PeopleAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

people_per_area
required
number <double> (People Per Area) >= 0

People per floor area expressed as [people/m2]

occupancy_schedule
required
string (Occupancy Schedule) [ 1 .. 100 ] characters

Identifier of a schedule for the occupancy over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the people_per_area to yield a complete occupancy profile.

activity_schedule
required
string (Activity Schedule) [ 1 .. 100 ] characters

Identifier of a schedule for the activity of the occupants over the course of the year. The type of this schedule should be Power and the values of the schedule equal to the number of Watts given off by an individual person in the room.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0.3

The radiant fraction of sensible heat released by people. The defaultvalue is 0.30.

Autocalculate (object) or number (Latent Fraction)
Default: {"type":"Autocalculate"}

Number for the latent fraction of heat gain due to people or an Autocalculate object.

{
  • "type": "PeopleAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "people_per_area": 0,
  • "occupancy_schedule": "string",
  • "activity_schedule": "string",
  • "radiant_fraction": 0.3,
  • "latent_fraction": {
    }
}

Plane

type
string^Plane$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

n
required
Array of numbers <double> (N) 3 items

Plane normal as 3 (x, y, z) values.

o
required
Array of numbers <double> (O) 3 items

Plane origin as 3 (x, y, z) values

x
Array of numbers <double> (X) 3 items

Plane x-axis as 3 (x, y, z) values. If None, it is autocalculated.

{
  • "type": "Plane",
  • "n": [
    ],
  • "o": [
    ],
  • "x": [
    ]
}

Plastic

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"void"}

Material modifier (default: Void).

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).

r_reflectance
number <double> (R Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel reflectance (default: 0).

g_reflectance
number <double> (G Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel reflectance (default: 0).

b_reflectance
number <double> (B Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel reflectance (default: 0).

specularity
number <double> (Specularity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic for non-metallic materials. (default: 0).

roughness
number <double> (Roughness) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the roughness, specified as the rms slope of surface facets. Roughness greater than 0.2 are not realistic (default: 0).

{
  • "type": "plastic",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": null,
  • "dependencies": [
    ],
  • "r_reflectance": 0,
  • "g_reflectance": 0,
  • "b_reflectance": 0,
  • "specularity": 0,
  • "roughness": 0
}

ProgramType

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

people
object (People) Recursive

People to describe the occupancy of the program. If None, no occupancy will be assumed for the program.

lighting
object (Lighting) Recursive

Lighting to describe the lighting usage of the program. If None, no lighting will be assumed for the program.

electric_equipment
object (Electric Equipment) Recursive

ElectricEquipment to describe the usage of electric equipment within the program. If None, no electric equipment will be assumed.

gas_equipment
object (Gas Equipment) Recursive

GasEquipment to describe the usage of gas equipment within the program. If None, no gas equipment will be assumed.

service_hot_water
object (Service Hot Water) Recursive

ServiceHotWater object to describe the usage of hot water within the program. If None, no hot water will be assumed.

infiltration
object (Infiltration) Recursive

Infiltration to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program.

ventilation
object (Ventilation) Recursive

Ventilation to describe the minimum outdoor air requirement of the program. If None, no ventilation requirement will be assumed.

setpoint
object (Setpoint) Recursive

Setpoint object to describe the temperature and humidity setpoints of the program. If None, the ProgramType cannot be assigned to a Room that is conditioned.

{
  • "type": "ProgramType",
  • "identifier": "string",
  • "display_name": "string",
  • "people": {
    },
  • "lighting": {
    },
  • "electric_equipment": {
    },
  • "gas_equipment": {
    },
  • "service_hot_water": {
    },
  • "infiltration": {
    },
  • "ventilation": {
    },
  • "setpoint": {
    }
}

ProgramTypeAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

people
object (People) Recursive

People to describe the occupancy of the program. If None, no occupancy will be assumed for the program.

lighting
object (Lighting) Recursive

Lighting to describe the lighting usage of the program. If None, no lighting will be assumed for the program.

electric_equipment
object (Electric Equipment) Recursive

ElectricEquipment to describe the usage of electric equipment within the program. If None, no electric equipment will be assumed.

gas_equipment
object (Gas Equipment) Recursive

GasEquipment to describe the usage of gas equipment within the program. If None, no gas equipment will be assumed.

service_hot_water
object (Service Hot Water) Recursive

ServiceHotWater object to describe the usage of hot water within the program. If None, no hot water will be assumed.

infiltration
object (Infiltration) Recursive

Infiltration to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program.

ventilation
object (Ventilation) Recursive

Ventilation to describe the minimum outdoor air requirement of the program. If None, no ventilation requirement will be assumed.

setpoint
object (Setpoint) Recursive

Setpoint object to describe the temperature and humidity setpoints of the program. If None, the ProgramType cannot be assigned to a Room that is conditioned.

{
  • "type": "ProgramTypeAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "people": {
    },
  • "lighting": {
    },
  • "electric_equipment": {
    },
  • "gas_equipment": {
    },
  • "service_hot_water": {
    },
  • "infiltration": {
    },
  • "ventilation": {
    },
  • "setpoint": {
    }
}

PSZ

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

economizer_type
string
Default: "Inferred"
Enum: "Inferred" "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

equipment_type
string
Default: "PSZAC_ElectricBaseboard"
Enum: "PSZAC_ElectricBaseboard" "PSZAC_BoilerBaseboard" "PSZAC_DHWBaseboard" "PSZAC_GasHeaters" "PSZAC_ElectricCoil" "PSZAC_GasCoil" "PSZAC_Boiler" "PSZAC_ASHP" "PSZAC_DHW" "PSZAC" "PSZAC_DCW_ElectricBaseboard" "PSZAC_DCW_BoilerBaseboard" "PSZAC_DCW_GasHeaters" "PSZAC_DCW_ElectricCoil" "PSZAC_DCW_GasCoil" "PSZAC_DCW_Boiler" "PSZAC_DCW_ASHP" "PSZAC_DCW_DHW" "PSZAC_DCW" "PSZHP"

Text for the specific type of system equipment from the PVAVEquipmentType enumeration.

{
  • "type": "PSZ",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "economizer_type": "Inferred",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    },
  • "equipment_type": "PSZAC_ElectricBaseboard"
}

PSZEquipmentType

string (PSZEquipmentType)
Enum: "PSZAC_ElectricBaseboard" "PSZAC_BoilerBaseboard" "PSZAC_DHWBaseboard" "PSZAC_GasHeaters" "PSZAC_ElectricCoil" "PSZAC_GasCoil" "PSZAC_Boiler" "PSZAC_ASHP" "PSZAC_DHW" "PSZAC" "PSZAC_DCW_ElectricBaseboard" "PSZAC_DCW_BoilerBaseboard" "PSZAC_DCW_GasHeaters" "PSZAC_DCW_ElectricCoil" "PSZAC_DCW_GasCoil" "PSZAC_DCW_Boiler" "PSZAC_DCW_ASHP" "PSZAC_DCW_DHW" "PSZAC_DCW" "PSZHP"

An enumeration.

"PSZAC_ElectricBaseboard"

PTAC

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

economizer_type
string
Default: "Inferred"
Enum: "Inferred" "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

equipment_type
string
Default: "PTAC_ElectricBaseboard"
Enum: "PTAC_ElectricBaseboard" "PTAC_BoilerBaseboard" "PTAC_DHWBaseboard" "PTAC_GasHeaters" "PTAC_ElectricCoil" "PTAC_GasCoil" "PTAC_Boiler" "PTAC_ASHP" "PTAC_DHW" "PTAC" "PTHP"

Text for the specific type of system equipment from the PTACEquipmentType enumeration.

{
  • "type": "PTAC",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "economizer_type": "Inferred",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    },
  • "equipment_type": "PTAC_ElectricBaseboard"
}

PTACEquipmentType

string (PTACEquipmentType)
Enum: "PTAC_ElectricBaseboard" "PTAC_BoilerBaseboard" "PTAC_DHWBaseboard" "PTAC_GasHeaters" "PTAC_ElectricCoil" "PTAC_GasCoil" "PTAC_Boiler" "PTAC_ASHP" "PTAC_DHW" "PTAC" "PTHP"

An enumeration.

"PTAC_ElectricBaseboard"

PVAV

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

economizer_type
string
Default: "Inferred"
Enum: "Inferred" "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

equipment_type
string
Default: "PVAV_Boiler"
Enum: "PVAV_Boiler" "PVAV_ASHP" "PVAV_DHW" "PVAV_PFP" "PVAV_BoilerElectricReheat"

Text for the specific type of system equipment from the VAVEquipmentType enumeration.

{
  • "type": "PVAV",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "economizer_type": "Inferred",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    },
  • "equipment_type": "PVAV_Boiler"
}

PVAVEquipmentType

string (PVAVEquipmentType)
Enum: "PVAV_Boiler" "PVAV_ASHP" "PVAV_DHW" "PVAV_PFP" "PVAV_BoilerElectricReheat"

An enumeration.

"PVAV_Boiler"

RadianceShadeStateAbridged

type
string^RadianceShadeStateAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A Radiance Modifier identifier (default: None).

modifier_direct
string (Modifier Direct)

A Radiance Modifier identifier (default: None).

Array of objects (Shades)

A list of StateGeometryAbridged objects (default: None).

{
  • "type": "RadianceShadeStateAbridged",
  • "modifier": "string",
  • "modifier_direct": "string",
  • "shades": [
    ]
}

RadianceSubFaceStateAbridged

type
string^RadianceShadeStateAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A Radiance Modifier identifier (default: None).

modifier_direct
string (Modifier Direct)

A Radiance Modifier identifier (default: None).

Array of objects (Shades)

A list of StateGeometryAbridged objects (default: None).

vmtx_geometry
object (Vmtx Geometry) Recursive

A Face3D for the view matrix geometry (default: None).

dmtx_geometry
object (Dmtx Geometry) Recursive

A Face3D for the daylight matrix geometry (default: None).

{
  • "type": "RadianceSubFaceStateAbridged",
  • "modifier": "string",
  • "modifier_direct": "string",
  • "shades": [
    ],
  • "vmtx_geometry": {
    },
  • "dmtx_geometry": {
    }
}

Residential

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

equipment_type
string
Default: "ResidentialAC_ElectricBaseboard"
Enum: "ResidentialAC_ElectricBaseboard" "ResidentialAC_BoilerBaseboard" "ResidentialAC_ASHPBaseboard" "ResidentialAC_DHWBaseboard" "ResidentialAC_ResidentialFurnace" "ResidentialAC" "ResidentialHP" "ResidentialHPNoCool" "ResidentialFurnace"

Text for the specific type of system equipment from the ResidentialEquipmentType enumeration.

{
  • "type": "Residential",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "equipment_type": "ResidentialAC_ElectricBaseboard"
}

ResidentialEquipmentType

string (ResidentialEquipmentType)
Enum: "ResidentialAC_ElectricBaseboard" "ResidentialAC_BoilerBaseboard" "ResidentialAC_ASHPBaseboard" "ResidentialAC_DHWBaseboard" "ResidentialAC_ResidentialFurnace" "ResidentialAC" "ResidentialHP" "ResidentialHPNoCool" "ResidentialFurnace"

An enumeration.

"ResidentialAC_ElectricBaseboard"

RoofCeilingConstructionSet

type
string^RoofCeilingConstructionSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

An OpaqueConstruction for walls with a Surface or Adiabatic boundary condition.

exterior_construction
object (Exterior Construction) Recursive

An OpaqueConstruction for walls with an Outdoors boundary condition.

ground_construction
object (Ground Construction) Recursive

An OpaqueConstruction for walls with a Ground boundary condition.

{
  • "type": "RoofCeilingConstructionSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "ground_construction": {
    }
}

RoofCeilingConstructionSetAbridged

type
string^_FaceSubSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.

ground_construction
string (Ground Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Ground boundary condition.

{
  • "type": "RoofCeilingConstructionSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "ground_construction": "string"
}

RoofCeilingModifierSet

type
string^RoofCeilingModifierSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "RoofCeilingModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

RoofCeilingModifierSetAbridged

type
string^BaseModifierSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "RoofCeilingModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

Room

type
string^IDdBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of objects (Faces) >= 4 items

Faces that together form the closed volume of a room.

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

Array of objects (Indoor Shades)

Shades assigned to the interior side of this object (eg. partitions, tables).

Array of objects (Outdoor Shades)

Shades assigned to the exterior side of this object (eg. trees, landscaping).

multiplier
integer <int32> (Multiplier) >= 1
Default: 1

An integer noting how many times this Room is repeated. Multipliers are used to speed up the calculation when similar Rooms are repeated more than once. Essentially, a given simulation with the Room is run once and then the result is mutliplied by the multiplier.

story
string (Story) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Text string for the story identifier to which this Room belongs. Rooms sharing the same story identifier are considered part of the same story in a Model.

{
  • "type": "Room",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "faces": [
    ],
  • "properties": {
    },
  • "indoor_shades": [
    ],
  • "outdoor_shades": [
    ],
  • "multiplier": 1,
  • "story": "string"
}

RoomEnergyPropertiesAbridged

type
string^RoomEnergyPropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

construction_set
string (Construction Set) [ 1 .. 100 ] characters

Identifier of a ConstructionSet to specify all default constructions for the Faces, Apertures, and Doors of the Room. If None, the Room will use the Model global_construction_set.

program_type
string (Program Type) [ 1 .. 100 ] characters

Identifier of a ProgramType to specify all default schedules and loads for the Room. If None, the Room will have no loads or setpoints.

hvac
string (Hvac) [ 1 .. 100 ] characters

An optional identifier of a HVAC system (such as an IdealAirSystem) that specifies how the Room is conditioned. If None, it will be assumed that the Room is not conditioned.

people
object (People) Recursive

People object to describe the occupancy of the Room.

lighting
object (Lighting) Recursive

Lighting object to describe the lighting usage of the Room.

electric_equipment
object (Electric Equipment) Recursive

ElectricEquipment object to describe the electric equipment usage.

gas_equipment
object (Gas Equipment) Recursive

GasEquipment object to describe the gas equipment usage.

service_hot_water
object (Service Hot Water) Recursive

ServiceHotWater object to describe the hot water usage.

infiltration
object (Infiltration) Recursive

Infiltration object to to describe the outdoor air leakage.

ventilation
object (Ventilation) Recursive

Ventilation object for the minimum outdoor air requirement.

setpoint
object (Setpoint) Recursive

Setpoint object for the temperature setpoints of the Room.

window_vent_control
object (Window Vent Control) Recursive

An optional VentilationControl object to dictate the opening of windows. If None, the windows will never open.

{
  • "type": "RoomEnergyPropertiesAbridged",
  • "construction_set": "string",
  • "program_type": "string",
  • "hvac": "string",
  • "people": {
    },
  • "lighting": {
    },
  • "electric_equipment": {
    },
  • "gas_equipment": {
    },
  • "service_hot_water": {
    },
  • "infiltration": {
    },
  • "ventilation": {
    },
  • "setpoint": {
    },
  • "window_vent_control": {
    }
}

RoomPropertiesAbridged

type
string^RoomPropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

energy
object (RoomEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (RoomRadiancePropertiesAbridged) Recursive

Abridged Radiance Properties for Honeybee Room.

{
  • "type": "RoomPropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

RoomRadiancePropertiesAbridged

type
string^RoomRadiancePropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

modifier_set
string (Modifier Set)

An identifier for a unique Room-Assigned ModifierSet (default: None).

{
  • "type": "RoomRadiancePropertiesAbridged",
  • "modifier_set": "string"
}

Roughness

string (Roughness)
Enum: "VeryRough" "Rough" "MediumRough" "MediumSmooth" "Smooth" "VerySmooth"

Relative roughness of a particular material layer.

"VeryRough"

ScheduleDay

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

values
required
Array of numbers <double> (Values)

A list of floats or integers for the values of the schedule. The length of this list must match the length of the times list.

times
Array of Array of integers (Times)
Default: [0,0]

A list of lists with each sub-list possesing 2 values for [hour, minute]. The length of the master list must match the length of the values list. Each time in the master list represents the time of day that the corresponding value begins to take effect. For example [(0,0), (9,0), (17,0)] in combination with the values [0, 1, 0] denotes a schedule value of 0 from 0:00 to 9:00, a value of 1 from 9:00 to 17:00 and 0 from 17:00 to the end of the day. Note that this representation of times as the "time of beginning" is a different convention than EnergyPlus, which uses "time until".

interpolate
boolean (Interpolate)
Default: false

Boolean to note whether values in between times should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.

{
  • "type": "ScheduleDay",
  • "identifier": "string",
  • "display_name": "string",
  • "values": [
    ],
  • "times": [
    ],
  • "interpolate": false
}

ScheduleFixedInterval

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

values
required
Array of numbers <double> (Values) [ 24 .. 527040 ] items

A list of timeseries values occuring at each timestep over the course of the simulation.

schedule_type_limit
object (Schedule Type Limit) Recursive

ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.

timestep
integer <int32> (Timestep)
Default: 1

An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.

start_date
Array of integers <int32> (Start Date) [ 2 .. 3 ] items
Default: [1,1]

A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).

placeholder_value
number <double> (Placeholder Value)
Default: 0

A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.

interpolate
boolean (Interpolate)
Default: false

Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.

{
  • "type": "ScheduleFixedInterval",
  • "identifier": "string",
  • "display_name": "string",
  • "values": [
    ],
  • "schedule_type_limit": {
    },
  • "timestep": 1,
  • "start_date": [
    ],
  • "placeholder_value": 0,
  • "interpolate": false
}

ScheduleFixedIntervalAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

values
required
Array of numbers <double> (Values) [ 24 .. 527040 ] items

A list of timeseries values occuring at each timestep over the course of the simulation.

schedule_type_limit
string (Schedule Type Limit) [ 1 .. 100 ] characters

Identifier of a ScheduleTypeLimit that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.

timestep
integer <int32> (Timestep)
Default: 1

An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.

start_date
Array of integers <int32> (Start Date) [ 2 .. 3 ] items
Default: [1,1]

A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).

placeholder_value
number <double> (Placeholder Value)
Default: 0

A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.

interpolate
boolean (Interpolate)
Default: false

Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.

{
  • "type": "ScheduleFixedIntervalAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "values": [
    ],
  • "schedule_type_limit": "string",
  • "timestep": 1,
  • "start_date": [
    ],
  • "placeholder_value": 0,
  • "interpolate": false
}

ScheduleNumericType

string (ScheduleNumericType)
Enum: "Continuous" "Discrete"

Designates how the range values are validated.

"Continuous"

ScheduleRuleAbridged

type
string^DatedBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

schedule_day
required
string (Schedule Day) [ 1 .. 100 ] characters

The identifier of a ScheduleDay object associated with this rule.

apply_sunday
boolean (Apply Sunday)
Default: false

Boolean noting whether to apply schedule_day on Sundays.

apply_monday
boolean (Apply Monday)
Default: false

Boolean noting whether to apply schedule_day on Mondays.

apply_tuesday
boolean (Apply Tuesday)
Default: false

Boolean noting whether to apply schedule_day on Tuesdays.

apply_wednesday
boolean (Apply Wednesday)
Default: false

Boolean noting whether to apply schedule_day on Wednesdays.

apply_thursday
boolean (Apply Thursday)
Default: false

Boolean noting whether to apply schedule_day on Thursdays.

apply_friday
boolean (Apply Friday)
Default: false

Boolean noting whether to apply schedule_day on Fridays.

apply_saturday
boolean (Apply Saturday)
Default: false

Boolean noting whether to apply schedule_day on Saturdays.

start_date
Array of integers <int32> (Start Date) [ 2 .. 3 ] items
Default: [1,1]

A list of two integers for [month, day], representing the start date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).

end_date
Array of integers <int32> (End Date) [ 2 .. 3 ] items
Default: [12,31]

A list of two integers for [month, day], representing the end date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).

{
  • "type": "ScheduleRuleAbridged",
  • "schedule_day": "string",
  • "apply_sunday": false,
  • "apply_monday": false,
  • "apply_tuesday": false,
  • "apply_wednesday": false,
  • "apply_thursday": false,
  • "apply_friday": false,
  • "apply_saturday": false,
  • "start_date": [
    ],
  • "end_date": [
    ]
}

ScheduleRuleset

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

required
Array of objects (Day Schedules)

A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.

default_day_schedule
required
string (Default Day Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.

Array of objects (Schedule Rules)

A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.

holiday_schedule
string (Holiday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.

summer_designday_schedule
string (Summer Designday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.

winter_designday_schedule
string (Winter Designday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.

schedule_type_limit
object (Schedule Type Limit) Recursive

ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.

{
  • "type": "ScheduleRuleset",
  • "identifier": "string",
  • "display_name": "string",
  • "day_schedules": [
    ],
  • "default_day_schedule": "string",
  • "schedule_rules": [
    ],
  • "holiday_schedule": "string",
  • "summer_designday_schedule": "string",
  • "winter_designday_schedule": "string",
  • "schedule_type_limit": {
    }
}

ScheduleRulesetAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

required
Array of objects (Day Schedules)

A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.

default_day_schedule
required
string (Default Day Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.

Array of objects (Schedule Rules)

A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.

holiday_schedule
string (Holiday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.

summer_designday_schedule
string (Summer Designday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.

winter_designday_schedule
string (Winter Designday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.

schedule_type_limit
string (Schedule Type Limit) [ 1 .. 100 ] characters

Identifier of a ScheduleTypeLimit that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.

{
  • "type": "ScheduleRulesetAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "day_schedules": [
    ],
  • "default_day_schedule": "string",
  • "schedule_rules": [
    ],
  • "holiday_schedule": "string",
  • "summer_designday_schedule": "string",
  • "winter_designday_schedule": "string",
  • "schedule_type_limit": "string"
}

ScheduleTypeLimit

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

NoLimit (object) or number (Lower Limit)
Default: {"type":"NoLimit"}

Lower limit for the schedule type or NoLimit.

NoLimit (object) or number (Upper Limit)
Default: {"type":"NoLimit"}

Upper limit for the schedule type or NoLimit.

numeric_type
string
Default: "Continuous"
Enum: "Continuous" "Discrete"

Designates how the range values are validated.

unit_type
string
Default: "Dimensionless"
Enum: "Dimensionless" "Temperature" "DeltaTemperature" "PrecipitationRate" "Angle" "ConvectionCoefficient" "ActivityLevel" "Velocity" "Capacity" "Power" "Availability" "Percent" "Control" "Mode"

An enumeration.

{
  • "type": "ScheduleTypeLimit",
  • "identifier": "string",
  • "display_name": "string",
  • "lower_limit": {
    },
  • "upper_limit": {
    },
  • "numeric_type": "Continuous",
  • "unit_type": "Dimensionless"
}

ScheduleUnitType

string (ScheduleUnitType)
Enum: "Dimensionless" "Temperature" "DeltaTemperature" "PrecipitationRate" "Angle" "ConvectionCoefficient" "ActivityLevel" "Velocity" "Capacity" "Power" "Availability" "Percent" "Control" "Mode"

An enumeration.

"Dimensionless"

Sensor

type
string^Sensor$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

pos
required
Array of numbers <double> (Pos) 3 items

Position of sensor in space as an array of (x, y, z) values.

dir
required
Array of numbers <double> (Dir) 3 items

Direction of sensor as an array of (x, y, z) values.

{
  • "type": "Sensor",
  • "pos": [
    ],
  • "dir": [
    ]
}

SensorGrid

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

room_identifier
string (Room Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Optional text string for the Room identifier to which this object belongs. This will be used to narrow down the number of aperture groups that have to be run with this sensor grid. If None, the grid will be run with all aperture groups in the model.

light_path
Array of Array of strings (Light Path)

Get or set a list of lists for the light path from the object to the sky. Each sub-list contains identifiers of aperture groups through which light passes. (eg. [["SouthWindow1"], ["static_apertures", "NorthWindow2"]]).Setting this property will override any auto-calculation of the light path from the model and room_identifier upon export to the simulation.

required
Array of objects (Sensors)

A list of sensors that belong to the grid.

mesh
object (Mesh) Recursive

An optional Mesh3D that aligns with the sensors and can be used for visualization of the grid. Note that the number of sensors in the grid must match the number of faces or the number vertices within the Mesh3D.

Array of objects (Base Geometry)

An optional array of Face3D used to represent the grid. There are no restrictions on how this property relates to the sensors and it is provided only to assist with the display of the grid when the number of sensors or the mesh is too large to be practically visualized.

group_identifier
string (Group Identifier)

An optional string to note the sensor grid group ' 'to which the sensor is a part of. Grids sharing the same ' 'group_identifier will be written to the same subfolder in Radiance ' 'folder (default: None).

{
  • "type": "SensorGrid",
  • "identifier": "string",
  • "display_name": "string",
  • "room_identifier": "string",
  • "light_path": [
    ],
  • "sensors": [
    ],
  • "mesh": {
    },
  • "base_geometry": [
    ],
  • "group_identifier": "string"
}

ServiceHotWater

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

flow_per_area
required
number <double> (Flow Per Area) >= 0

Number for the total volume flow rate of water per unit area of floor [L/h-m2].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the use of hot water over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_area to yield a complete water usage profile.

target_temperature
number <double> (Target Temperature)
Default: 60

Number for the target temperature of water out of the tap (C). This the temperature after hot water has been mixed with cold water from the water mains. The default is 60C, which essentially assumes that the flow_per_area on this object is only for water straight out of the water heater.

sensible_fraction
number <double> (Sensible Fraction) [ 0 .. 1 ]
Default: 0.2

A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0.05

A number between 0 and 1 for the fraction of the total hot water load that is latent.

{
  • "type": "ServiceHotWater",
  • "identifier": "string",
  • "display_name": "string",
  • "flow_per_area": 0,
  • "schedule": {
    },
  • "target_temperature": 60,
  • "sensible_fraction": 0.2,
  • "latent_fraction": 0.05
}

ServiceHotWaterAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

flow_per_area
required
number <double> (Flow Per Area) >= 0

Number for the total volume flow rate of water per unit area of floor [L/h-m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the hot water use over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_area to yield a complete water usage profile.

target_temperature
number <double> (Target Temperature)
Default: 60

Number for the target temperature of water out of the tap (C). This the temperature after hot water has been mixed with cold water from the water mains. The default is 60C, which essentially assumes that the flow_per_area on this object is only for water straight out of the water heater.

sensible_fraction
number <double> (Sensible Fraction) [ 0 .. 1 ]
Default: 0.2

A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0.05

A number between 0 and 1 for the fraction of the total hot water load that is latent.

{
  • "type": "ServiceHotWaterAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "flow_per_area": 0,
  • "schedule": "string",
  • "target_temperature": 60,
  • "sensible_fraction": 0.2,
  • "latent_fraction": 0.05
}

Setpoint

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Cooling Schedule)

Schedule for the cooling setpoint. The values in this schedule should be temperature in [C].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Heating Schedule)

Schedule for the heating setpoint. The values in this schedule should be temperature in [C].

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Humidifying Schedule)

Schedule for the humidification setpoint. The values in this schedule should be in [%].

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Dehumidifying Schedule)

Schedule for the dehumidification setpoint. The values in this schedule should be in [%].

{
  • "type": "Setpoint",
  • "identifier": "string",
  • "display_name": "string",
  • "cooling_schedule": {
    },
  • "heating_schedule": {
    },
  • "humidifying_schedule": {
    },
  • "dehumidifying_schedule": {
    }
}

SetpointAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

cooling_schedule
required
string (Cooling Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the cooling setpoint. The values in this schedule should be temperature in [C].

heating_schedule
required
string (Heating Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the heating setpoint. The values in this schedule should be temperature in [C].

humidifying_schedule
string (Humidifying Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the humidification setpoint. The values in this schedule should be in [%].

dehumidifying_schedule
string (Dehumidifying Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the dehumidification setpoint. The values in this schedule should be in [%].

{
  • "type": "SetpointAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "cooling_schedule": "string",
  • "heating_schedule": "string",
  • "humidifying_schedule": "string",
  • "dehumidifying_schedule": "string"
}

Shade

type
string^IDdBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

geometry
required
object (Geometry) Recursive

Planar Face3D for the geometry.

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

is_detached
boolean (Is Detached)
Default: false

Boolean to note whether this shade is detached from any of the other geometry in the model. Cases where this should be True include shade representing surrounding buildings or context. Note that this should always be False for shades assigned to parent objects.

{
  • "type": "Shade",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": {
    },
  • "properties": {
    },
  • "is_detached": false
}

ShadeConstruction

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

solar_reflectance
number <double> (Solar Reflectance) [ 0 .. 1 ]
Default: 0.2

A number for the solar reflectance of the construction.

visible_reflectance
number <double> (Visible Reflectance) [ 0 .. 1 ]
Default: 0.2

A number for the visible reflectance of the construction.

is_specular
boolean (Is Specular)
Default: false

Boolean to note whether the reflection off the shade is diffuse (False) or specular (True). Set to True if the construction is representing a glass facade or a mirror material.

{
  • "type": "ShadeConstruction",
  • "identifier": "string",
  • "display_name": "string",
  • "solar_reflectance": 0.2,
  • "visible_reflectance": 0.2,
  • "is_specular": false
}

ShadeEnergyPropertiesAbridged

type
string^ShadeEnergyPropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

construction
string (Construction) [ 1 .. 100 ] characters

Identifier of a ShadeConstruction to set the reflectance and specularity of the Shade. If None, the construction is set by theparent Room construction_set, the Model global_construction_set or (in the case fo an orphaned shade) the EnergyPlus default of 0.2 diffuse reflectance.

transmittance_schedule
string (Transmittance Schedule) [ 1 .. 100 ] characters

Identifier of a schedule to set the transmittance of the shade, which can vary throughout the simulation. If None, the shade will be completely opaque.

{
  • "type": "ShadeEnergyPropertiesAbridged",
  • "construction": "string",
  • "transmittance_schedule": "string"
}

ShadeLocation

string (ShadeLocation)
Enum: "Interior" "Between" "Exterior"

Choices for where a shade material is located in a window assembly.

"Interior"

ShadeModifierSet

type
string^ShadeModifierSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "ShadeModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

ShadeModifierSetAbridged

type
string^BaseModifierSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "ShadeModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

ShadePropertiesAbridged

type
string^ShadePropertiesAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

energy
object (ShadeEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (ShadeRadiancePropertiesAbridged) Recursive

Radiance Properties for Honeybee Shade Abridged.

{
  • "type": "ShadePropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

ShadeRadiancePropertiesAbridged

type
string^_PropertiesBaseAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

dynamic_group_identifier
string (Dynamic Group Identifier)

An optional string to note the dynamic group ' 'to which the Shade is a part of. Shades sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Shade is assumed to be static. (default: None).

Array of objects (States)

An optional list of abridged states (default: None).

{
  • "type": "ShadeRadiancePropertiesAbridged",
  • "modifier": "string",
  • "modifier_blk": "string",
  • "dynamic_group_identifier": "string",
  • "states": [
    ]
}

SlatOrientation

string (SlatOrientation)
Enum: "Horizontal" "Vertical"

An enumeration.

"Horizontal"

StateGeometryAbridged

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

geometry
required
object (Geometry) Recursive

A ladybug_geometry Face3D.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier identifier (default: None).

modifier_direct
string (Modifier Direct)

A string for Honeybee Radiance Modifier identifiers to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

{
  • "type": "StateGeometryAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "geometry": {
    },
  • "modifier": "string",
  • "modifier_direct": "string"
}

Surface

type
string^Surface$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

boundary_condition_objects
required
Array of strings (Boundary Condition Objects) [ 2 .. 3 ] items

A list of up to 3 object identifiers that are adjacent to this one. The first object is always the one that is immediately adjacent and is of the same object type (Face, Aperture, Door). When this boundary condition is applied to a Face, the second object in the tuple will be the parent Room of the adjacent object. When the boundary condition is applied to a sub-face (Door or Aperture), the second object will be the parent Face of the adjacent sub-face and the third object will be the parent Room of the adjacent sub-face.

{
  • "type": "Surface",
  • "boundary_condition_objects": [
    ]
}

Trans

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"void"}

Material modifier (default: Void).

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).

r_reflectance
number <double> (R Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel reflectance (default: 0).

g_reflectance
number <double> (G Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel reflectance (default: 0).

b_reflectance
number <double> (B Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel reflectance (default: 0).

specularity
number <double> (Specularity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic for non-metallic materials. (default: 0).

roughness
number <double> (Roughness) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the roughness, specified as the rms slope of surface facets. Roughness greater than 0.2 are not realistic (default: 0).

transmitted_diff
number <double> (Transmitted Diff) [ 0 .. 1 ]
Default: 0

The fraction of transmitted light that is transmitted diffusely in a scattering fashion (default: 0).

transmitted_spec
number <double> (Transmitted Spec) [ 0 .. 1 ]
Default: 0

The fraction of transmitted light that is not diffusely scattered (default: 0).

{
  • "type": "trans",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_reflectance": 0,
  • "g_reflectance": 0,
  • "b_reflectance": 0,
  • "specularity": 0,
  • "roughness": 0,
  • "transmitted_diff": 0,
  • "transmitted_spec": 0
}

Units

string (Units)
Enum: "Meters" "Millimeters" "Feet" "Inches" "Centimeters"

An enumeration.

"Meters"

VAV

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

economizer_type
string
Default: "Inferred"
Enum: "Inferred" "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

equipment_type
string
Default: "VAV_Chiller_Boiler"
Enum: "VAV_Chiller_Boiler" "VAV_Chiller_ASHP" "VAV_Chiller_DHW" "VAV_Chiller_PFP" "VAV_Chiller_GasCoil" "VAV_ACChiller_Boiler" "VAV_ACChiller_ASHP" "VAV_ACChiller_DHW" "VAV_ACChiller_PFP" "VAV_ACChiller_GasCoil" "VAV_DCW_Boiler" "VAV_DCW_ASHP" "VAV_DCW_DHW" "VAV_DCW_PFP" "VAV_DCW_GasCoil"

Text for the specific type of system equipment from the VAVEquipmentType enumeration.

{
  • "type": "VAV",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "economizer_type": "Inferred",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    },
  • "equipment_type": "VAV_Chiller_Boiler"
}

VAVEquipmentType

string (VAVEquipmentType)
Enum: "VAV_Chiller_Boiler" "VAV_Chiller_ASHP" "VAV_Chiller_DHW" "VAV_Chiller_PFP" "VAV_Chiller_GasCoil" "VAV_ACChiller_Boiler" "VAV_ACChiller_ASHP" "VAV_ACChiller_DHW" "VAV_ACChiller_PFP" "VAV_ACChiller_GasCoil" "VAV_DCW_Boiler" "VAV_DCW_ASHP" "VAV_DCW_DHW" "VAV_DCW_PFP" "VAV_DCW_GasCoil"

An enumeration.

"VAV_Chiller_Boiler"

Ventilation

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

flow_per_person
number <double> (Flow Per Person) >= 0
Default: 0

Intensity of ventilation in[] m3/s per person]. Note that setting this value does not mean that ventilation is varied based on real-time occupancy but rather that the design level of ventilation is determined using this value and the People object of the Room.

flow_per_area
number <double> (Flow Per Area) >= 0
Default: 0

Intensity of ventilation in [m3/s per m2 of floor area].

air_changes_per_hour
number <double> (Air Changes Per Hour) >= 0
Default: 0

Intensity of ventilation in air changes per hour (ACH) for the entire Room.

flow_per_zone
number <double> (Flow Per Zone) >= 0
Default: 0

Intensity of ventilation in m3/s for the entire Room.

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

Schedule for the ventilation over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the total design flow rate (determined from the sum of the other 4 fields) to yield a complete ventilation profile.

{
  • "type": "Ventilation",
  • "identifier": "string",
  • "display_name": "string",
  • "flow_per_person": 0,
  • "flow_per_area": 0,
  • "air_changes_per_hour": 0,
  • "flow_per_zone": 0,
  • "schedule": {
    }
}

VentilationAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

flow_per_person
number <double> (Flow Per Person) >= 0
Default: 0

Intensity of ventilation in[] m3/s per person]. Note that setting this value does not mean that ventilation is varied based on real-time occupancy but rather that the design level of ventilation is determined using this value and the People object of the Room.

flow_per_area
number <double> (Flow Per Area) >= 0
Default: 0

Intensity of ventilation in [m3/s per m2 of floor area].

air_changes_per_hour
number <double> (Air Changes Per Hour) >= 0
Default: 0

Intensity of ventilation in air changes per hour (ACH) for the entire Room.

flow_per_zone
number <double> (Flow Per Zone) >= 0
Default: 0

Intensity of ventilation in m3/s for the entire Room.

schedule
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the ventilation over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the total design flow rate (determined from the sum of the other 4 fields) to yield a complete ventilation profile.

{
  • "type": "VentilationAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "flow_per_person": 0,
  • "flow_per_area": 0,
  • "air_changes_per_hour": 0,
  • "flow_per_zone": 0,
  • "schedule": "string"
}

VentilationControlAbridged

type
string^VentilationControlAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

min_indoor_temperature
number <double> (Min Indoor Temperature) [ -100 .. 100 ]
Default: -100

A number for the minimum indoor temperature at which to ventilate in Celsius. Typically, this variable is used to initiate ventilation.

max_indoor_temperature
number <double> (Max Indoor Temperature) [ -100 .. 100 ]
Default: 100

A number for the maximum indoor temperature at which to ventilate in Celsius. This can be used to set a maximum temperature at which point ventilation is stopped and a cooling system is turned on.

min_outdoor_temperature
number <double> (Min Outdoor Temperature) [ -100 .. 100 ]
Default: -100

A number for the minimum outdoor temperature at which to ventilate in Celsius. This can be used to ensure ventilative cooling does not happen during the winter even if the Room is above the min_indoor_temperature.

max_outdoor_temperature
number <double> (Max Outdoor Temperature) [ -100 .. 100 ]
Default: 100

A number for the maximum indoor temperature at which to ventilate in Celsius. This can be used to set a limit for when it is considered too hot outside for ventilative cooling.

delta_temperature
number <double> (Delta Temperature) [ -100 .. 100 ]
Default: -100

A number for the temperature differential in Celsius between indoor and outdoor below which ventilation is shut off. This should usually be a positive number so that ventilation only occurs when the outdoors is cooler than the indoors. Negative numbers indicate how much hotter the outdoors can be than the indoors before ventilation is stopped.

schedule
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the ventilation over the course of the year. Note that this is applied on top of any setpoints. The type of this schedule should be On/Off and values should be either 0 (no possibility of ventilation) or 1 (ventilation possible).

{
  • "type": "VentilationControlAbridged",
  • "min_indoor_temperature": -100,
  • "max_indoor_temperature": 100,
  • "min_outdoor_temperature": -100,
  • "max_outdoor_temperature": 100,
  • "delta_temperature": -100,
  • "schedule": "string"
}

VentilationControlType

string (VentilationControlType)
Enum: "SingleZone" "MultiZoneWithDistribution" "MultiZoneWithoutDistribution"

An enumeration.

"SingleZone"

VentilationOpening

type
string^VentilationOpening$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

fraction_area_operable
number <double> (Fraction Area Operable) [ 0 .. 1 ]
Default: 0.5

A number for the fraction of the window area that is operable.

fraction_height_operable
number <double> (Fraction Height Operable) [ 0 .. 1 ]
Default: 1

A number for the fraction of the distance from the bottom of the window to the top that is operable

discharge_coefficient
number <double> (Discharge Coefficient) [ 0 .. 1 ]
Default: 0.45

A number that will be multipled by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. Typical values include 0.45, for unobstructed windows WITH insect screens and 0.65 for unobstructed windows WITHOUT insect screens. This value should be lowered if windows are of an awning or casement type and are not allowed to fully open.

wind_cross_vent
boolean (Wind Cross Vent)
Default: false

Boolean to indicate if there is an opening of roughly equal area on the opposite side of the Room such that wind-driven cross ventilation will be induced. If False, the assumption is that the operable area is primarily on one side of the Room and there is no wind-driven ventilation.

flow_coefficient_closed
number <double> (Flow Coefficient Closed) >= 0

An optional number in kg/s-m, at 1 Pa per meter of crack length, used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage closed external window to be 0.00001, and the flow coefficient for a very poor, high-leakage closed external window to be 0.003.

flow_exponent_closed
number <double> (Flow Exponent Closed) [ 0.5 .. 1 ]
Default: 0.65

An optional dimensionless number between 0.5 and 1 used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.

two_way_threshold
number <double> (Two Way Threshold)
Default: 0.0001

A number in kg/m3 indicating the minimum density difference above which two-way flow may occur due to stack effect, required to run an AirflowNetwork simulation. This value is required because the air density difference between two zones (which drives two-way air flow) will tend towards division by zero errors as the air density difference approaches zero. The default of 0.0001 is a typical default value used for AirflowNetwork openings.

{
  • "type": "VentilationOpening",
  • "fraction_area_operable": 0.5,
  • "fraction_height_operable": 1,
  • "discharge_coefficient": 0.45,
  • "wind_cross_vent": false,
  • "flow_coefficient_closed": 0,
  • "flow_exponent_closed": 0.65,
  • "two_way_threshold": 0.0001
}

VentilationSimulationControl

type
string^VentilationSimulationControl$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

vent_control_type
string
Default: "SingleZone"
Enum: "SingleZone" "MultiZoneWithDistribution" "MultiZoneWithoutDistribution"

Text indicating type of ventilation control. Choices are: SingleZone, MultiZoneWithDistribution, MultiZoneWithoutDistribution. The MultiZone options will model air flow with the AirflowNetwork model, which is generally more accurate then the SingleZone option, but will take considerably longer to simulate, and requires defining more ventilation parameters to explicitly account for weather and building-induced pressure differences, and the leakage geometry corresponding to specific windows, doors, and surface cracks.

reference_temperature
number <double> (Reference Temperature) >= -273.15
Default: 20

Reference temperature measurement in Celsius under which the surface crack data were obtained.

reference_pressure
number <double> (Reference Pressure) [ 31000 .. 120000 ]
Default: 101325

Reference barometric pressure measurement in Pascals under which the surface crack data were obtained.

reference_humidity_ratio
number <double> (Reference Humidity Ratio) >= 0
Default: 0

Reference humidity ratio measurement in kgWater/kgDryAir under which the surface crack data were obtained.

building_type
string
Default: "LowRise"
Enum: "LowRise" "HighRise"

Text indicating relationship between building footprint and height used to calculate the wind pressure coefficients for exterior surfaces.Choices are: LowRise and HighRise. LowRise corresponds to rectangular building whose height is less then three times the width and length of the footprint. HighRise corresponds to a rectangular building whose height is more than three times the width and length of the footprint. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.

long_axis_angle
number <double> (Long Axis Angle) [ 0 .. 180 ]
Default: 0

The clockwise rotation in degrees from true North of the long axis of the building. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.

aspect_ratio
number <double> (Aspect Ratio) <= 1
Default: 1

Aspect ratio of a rectangular footprint, defined as the ratio of length of the short axis divided by the length of the long axis. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.

{
  • "type": "VentilationSimulationControl",
  • "vent_control_type": "SingleZone",
  • "reference_temperature": 20,
  • "reference_pressure": 101325,
  • "reference_humidity_ratio": 0,
  • "building_type": "LowRise",
  • "long_axis_angle": 0,
  • "aspect_ratio": 1
}

View

type
string^IDdRadianceBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier)

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

room_identifier
string (Room Identifier) [ 1 .. 100 ] characters [A-Za-z0-9_-]

Optional text string for the Room identifier to which this object belongs. This will be used to narrow down the number of aperture groups that have to be run with this sensor grid. If None, the grid will be run with all aperture groups in the model.

light_path
Array of Array of strings (Light Path)

Get or set a list of lists for the light path from the object to the sky. Each sub-list contains identifiers of aperture groups through which light passes. (eg. [["SouthWindow1"], ["static_apertures", "NorthWindow2"]]).Setting this property will override any auto-calculation of the light path from the model and room_identifier upon export to the simulation.

position
required
Array of numbers <double> (Position) 3 items

The view position (-vp) as an array of (x, y, z) values.This is the focal point of a perspective view or the center of a parallel projection.

direction
required
Array of numbers <double> (Direction) 3 items

The view direction (-vd) as an array of (x, y, z) values.The length of this vector indicates the focal distance as needed by the pixel depth of field (-pd) in rpict.

up_vector
required
Array of numbers <double> (Up Vector) 3 items

The view up (-vu) vector as an array of (x, y, z) values.

view_type
string
Default: "v"
Enum: "v" "h" "l" "c" "a" "s"

A single character for the view type (-vt).

h_size
number <double> (H Size)
Default: 60

A number for the horizontal field of view in degrees (for all perspective projections including fisheye). For a parallel projection, this is the view width in world coordinates.

v_size
number <double> (V Size)
Default: 60

A number for the vertical field of view in degrees (for all perspective projections including fisheye). For a parallel projection, this is the view width in world coordinates.

shift
number <double> (Shift)

The view shift (-vs). This is the amount the actual image will be shifted to the right of the specified view. This option is useful for generating skewed perspectives or rendering an image a piece at a time. A value of 1 means that the rendered image starts just to the right of the normal view. A value of -1 would be to the left. Larger or fractional values are permitted as well.

lift
number <double> (Lift)

The view lift (-vl). This is the amount the actual image will be lifted up from the specified view. This option is useful for generating skewed perspectives or rendering an image a piece at a time. A value of 1 means that the rendered image starts just to the right of the normal view. A value of -1 would be to the left. Larger or fractional values are permitted as well.

fore_clip
number <double> (Fore Clip)

View fore clip (-vo) at a distance from the view point.The plane will be perpendicular to the view direction for perspective and parallel view types. For fisheye view types, the clipping plane is actually a clipping sphere, centered on the view point with fore_clip radius. Objects in front of this imaginary surface will not be visible.

aft_clip
number <double> (Aft Clip)

View aft clip (-va) at a distance from the view point.Like the view fore plane, it will be perpendicular to the view direction for perspective and parallel view types. For fisheye view types, the clipping plane is actually a clipping sphere, centered on the view point with radius val.

group_identifier
string (Group Identifier)

An optional string to note the view group ' 'to which the sensor is a part of. Views sharing the same ' 'group_identifier will be written to the same subfolder in Radiance ' 'folder (default: None).

{
  • "type": "View",
  • "identifier": "string",
  • "display_name": "string",
  • "room_identifier": "string",
  • "light_path": [
    ],
  • "position": [
    ],
  • "direction": [
    ],
  • "up_vector": [
    ],
  • "view_type": "v",
  • "h_size": 60,
  • "v_size": 60,
  • "shift": 0,
  • "lift": 0,
  • "fore_clip": 0,
  • "aft_clip": 0,
  • "group_identifier": "string"
}

ViewType

string (ViewType)
Enum: "v" "h" "l" "c" "a" "s"

A single character for the view type (-vt).

"v"

Vintages

string (Vintages)
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

"ASHRAE_2013"

Void

type
string^void$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "void"
}

VRF

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

equipment_type
string
Default: "VRF"
Value: "VRF"

Text for the specific type of system equipment from the VRFEquipmentType enumeration.

{
  • "type": "VRF",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "equipment_type": "VRF"
}

VRFEquipmentType

string (VRFEquipmentType)
Value: "VRF"

An enumeration.

"VRF"

VRFwithDOAS

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

equipment_type
string
Default: "DOAS_VRF"
Value: "DOAS_VRF"

Text for the specific type of system equipment from the VRFwithDOASEquipmentType enumeration.

{
  • "type": "VRFwithDOAS",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    },
  • "equipment_type": "DOAS_VRF"
}

VRFwithDOASEquipmentType

string (VRFwithDOASEquipmentType)
Value: "DOAS_VRF"

An enumeration.

"DOAS_VRF"

WallConstructionSet

type
string^WallConstructionSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

An OpaqueConstruction for walls with a Surface or Adiabatic boundary condition.

exterior_construction
object (Exterior Construction) Recursive

An OpaqueConstruction for walls with an Outdoors boundary condition.

ground_construction
object (Ground Construction) Recursive

An OpaqueConstruction for walls with a Ground boundary condition.

{
  • "type": "WallConstructionSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "ground_construction": {
    }
}

WallConstructionSetAbridged

type
string^_FaceSubSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.

ground_construction
string (Ground Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Ground boundary condition.

{
  • "type": "WallConstructionSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "ground_construction": "string"
}

WallModifierSet

type
string^WallModifierSet$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "WallModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

WallModifierSetAbridged

type
string^BaseModifierSetAbridged$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "WallModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

WindowAC

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

equipment_type
string
Default: "WindowAC_ElectricBaseboard"
Enum: "WindowAC_ElectricBaseboard" "WindowAC_BoilerBaseboard" "WindowAC_ASHPBaseboard" "WindowAC_DHWBaseboard" "WindowAC_Furnace" "WindowAC_GasHeaters" "WindowAC"

Text for the specific type of system equipment from the WindowACEquipmentType enumeration.

{
  • "type": "WindowAC",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "equipment_type": "WindowAC_ElectricBaseboard"
}

WindowACEquipmentType

string (WindowACEquipmentType)
Enum: "WindowAC_ElectricBaseboard" "WindowAC_BoilerBaseboard" "WindowAC_ASHPBaseboard" "WindowAC_DHWBaseboard" "WindowAC_Furnace" "WindowAC_GasHeaters" "WindowAC"

An enumeration.

"WindowAC_ElectricBaseboard"

WindowConstruction

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

layers
required
Array of strings (Layers) [ 1 .. 8 ] items

List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.

required
Array of EnergyWindowMaterialSimpleGlazSys (object) or EnergyWindowMaterialGlazing (object) or EnergyWindowMaterialGas (object) or EnergyWindowMaterialGasCustom (object) or EnergyWindowMaterialGasMixture (object) (Materials) [ 1 .. 8 ] items

List of glazing and gas materials. The order of the materials is from outside to inside. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.

{
  • "type": "WindowConstruction",
  • "identifier": "string",
  • "display_name": "string",
  • "layers": [
    ],
  • "materials": [
    ]
}

WindowConstructionAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

layers
required
Array of strings (Layers) [ 1 .. 8 ] items

List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.

{
  • "type": "WindowConstructionAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "layers": [
    ]
}

WindowConstructionShade

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

window_construction
required
object (Window Construction) Recursive

A WindowConstruction object that serves as the "switched off" version of the construction (aka. the "bare construction"). The shade_material and shade_location will be used to modify this starting construction.

required
EnergyWindowMaterialShade (object) or EnergyWindowMaterialBlind (object) or EnergyWindowMaterialGlazing (object) (Shade Material)

Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.

shade_location
string
Default: "Interior"
Enum: "Interior" "Between" "Exterior"

Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the "Between" option. Also note that, for a WindowConstruction with more than one gas gap, the "Between" option defalts to using the inner gap as this is the only option that EnergyPlus supports.

control_type
string
Default: "AlwaysOn"
Enum: "AlwaysOn" "OnIfHighSolarOnWindow" "OnIfHighHorizontalSolar" "OnIfHighOutdoorAirTemperature" "OnIfHighZoneAirTemperature" "OnIfHighZoneCooling" "OnNightIfLowOutdoorTempAndOffDay" "OnNightIfLowInsideTempAndOffDay" "OnNightIfHeatingAndOffDay"

Text to indicate how the shading device is controlled, which determines when the shading is “on” or “off.”

setpoint
number <double> (Setpoint)

A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except "AlwaysOn."

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

An optional ScheduleRuleset or ScheduleFixedInterval to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.

{
  • "type": "WindowConstructionShade",
  • "identifier": "string",
  • "display_name": "string",
  • "window_construction": {
    },
  • "shade_material": {
    },
  • "shade_location": "Interior",
  • "control_type": "AlwaysOn",
  • "setpoint": 0,
  • "schedule": {
    }
}

WindowConstructionShadeAbridged

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

window_construction
required
object (Window Construction) Recursive

A WindowConstructionAbridged object that serves as the "switched off" version of the construction (aka. the "bare construction"). The shade_material and shade_location will be used to modify this starting construction.

shade_material
required
string (Shade Material) [ 1 .. 100 ] characters

Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.

shade_location
string
Default: "Interior"
Enum: "Interior" "Between" "Exterior"

Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the "Between" option. Also note that, for a WindowConstruction with more than one gas gap, the "Between" option defalts to using the inner gap as this is the only option that EnergyPlus supports.

control_type
string
Default: "AlwaysOn"
Enum: "AlwaysOn" "OnIfHighSolarOnWindow" "OnIfHighHorizontalSolar" "OnIfHighOutdoorAirTemperature" "OnIfHighZoneAirTemperature" "OnIfHighZoneCooling" "OnNightIfLowOutdoorTempAndOffDay" "OnNightIfLowInsideTempAndOffDay" "OnNightIfHeatingAndOffDay"

Text to indicate how the shading device is controlled, which determines when the shading is “on” or “off.”

setpoint
number <double> (Setpoint)

A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except "AlwaysOn."

schedule
string (Schedule) [ 1 .. 100 ] characters

An optional schedule identifier to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.

{
  • "type": "WindowConstructionShadeAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "window_construction": {
    },
  • "shade_material": "string",
  • "shade_location": "Interior",
  • "control_type": "AlwaysOn",
  • "setpoint": 0,
  • "schedule": "string"
}

WSHP

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

equipment_type
string
Default: "WSHP_FluidCooler_Boiler"
Enum: "WSHP_FluidCooler_Boiler" "WSHP_CoolingTower_Boiler" "WSHP_GSHP" "WSHP_DCW_DHW"

Text for the specific type of system equipment from the WSHPEquipmentType enumeration.

{
  • "type": "WSHP",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "equipment_type": "WSHP_FluidCooler_Boiler"
}

WSHPEquipmentType

string (WSHPEquipmentType)
Enum: "WSHP_FluidCooler_Boiler" "WSHP_CoolingTower_Boiler" "WSHP_GSHP" "WSHP_DCW_DHW"

An enumeration.

"WSHP_FluidCooler_Boiler"

WSHPwithDOAS

type
string^IDdEnergyBaseModel$
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

vintage
string
Default: "ASHRAE_2013"
Enum: "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

equipment_type
string
Default: "DOAS_WSHP_FluidCooler_Boiler"
Enum: "DOAS_WSHP_FluidCooler_Boiler" "DOAS_WSHP_CoolingTower_Boiler" "DOAS_WSHP_GSHP" "DOAS_WSHP_DCW_DHW"

Text for the specific type of system equipment from the WSHPwithDOASEquipmentType enumeration.

{
  • "type": "WSHPwithDOAS",
  • "identifier": "string",
  • "display_name": "string",
  • "vintage": "ASHRAE_2013",
  • "sensible_heat_recovery": {
    },
  • "latent_heat_recovery": {
    },
  • "equipment_type": "DOAS_WSHP_FluidCooler_Boiler"
}

WSHPwithDOASEquipmentType

string (WSHPwithDOASEquipmentType)
Enum: "DOAS_WSHP_FluidCooler_Boiler" "DOAS_WSHP_CoolingTower_Boiler" "DOAS_WSHP_GSHP" "DOAS_WSHP_DCW_DHW"

An enumeration.

"DOAS_WSHP_FluidCooler_Boiler"